{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Hyperline","colors":{"primary":"#1A1A1A","light":"#999999","dark":"#1A1A1A"},"logo":{"light":"https://mintcdn.com/hyperline/G-7ZQgHUOVHWwtUN/layout/logo-dark.png?fit=max\u0026auto=format\u0026n=G-7ZQgHUOVHWwtUN\u0026q=85\u0026s=2521f5f5ce4977d387d12aa169a8ee55","dark":"https://mintcdn.com/hyperline/G-7ZQgHUOVHWwtUN/layout/logo-light.png?fit=max\u0026auto=format\u0026n=G-7ZQgHUOVHWwtUN\u0026q=85\u0026s=c81125a44e9fdf8006623ab1f597ce7f"},"favicon":"https://mintcdn.com/hyperline/xZrQhb6Rphak0y92/favicon.png?fit=max\u0026auto=format\u0026n=xZrQhb6Rphak0y92\u0026q=85\u0026s=c52ed2ba655f301d3a99a7987888c622","api":{"openapi":["https://api.hyperline.co/openapi","https://ingest.hyperline.co/openapi"],"playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"},"server":["https://api.hyperline.co","https://ingest.hyperline.co"]}},"appearance":{"default":"light"},"background":{"color":{"light":"#fafafa","dark":"#1f1f1f"}},"navbar":{"links":[{"href":"https://www.hyperline.co/talk-to-sales","label":"Book a call"}],"primary":{"type":"button","label":"Get Started","href":"https://app.hyperline.co"}},"footer":{"links":[{"header":"Resources","items":[{"label":"Status","href":"https://status.hyperline.co"},{"label":"Changelog","href":"https://docs.hyperline.co/changelog"},{"label":"Glossary","href":"https://docs.hyperline.co/docs/introduction/glossary"},{"label":"Contact support","href":"mailto:support@hyperline.co"}]},{"header":"Company","items":[{"label":"Customers","href":"https://www.hyperline.co/resources/customers"},{"label":"Blog","href":"https://www.hyperline.co/resources/blog"},{"label":"Careers","href":"https://www.welcometothejungle.com/fr/companies/hyperline"},{"label":"Media Kit","href":"https://drive.google.com/drive/folders/1KIlufVDz6tgwohTFFv1jSyoqeHO0pKOm"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://www.hyperline.co/privacy-policy"},{"label":"Terms of Service","href":"https://www.hyperline.co/terms-of-service"},{"label":"Security","href":"https://docs.hyperline.co/security"}]}]},"seo":{"metatags":{"og:image":"https://app.hyperline.co/auth/background.svg"},"indexing":"navigable"},"fonts":{"family":"Inter"},"integrations":{"posthog":{"apiKey":"phc_KmmpIQ7SFNwnur6ZqVC118l5EkS1pqo313t4qxwL32n","apiHost":"https://eu.posthog.com"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hyperline","hasAudioNarration":false,"actualSubdomain":"hyperline","customDomains":["docs.hyperline.co"],"gitSource":{"type":"github","owner":"meterly","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aee222443b370b904925da5","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"Developers","count":361},{"language":"default","tag":"Documentation","count":111},{"language":"default","tag":"Integrations","count":42},{"language":"default","tag":"Subscriptions","count":37},{"language":"default","tag":"Invoices","count":36},{"language":"default","tag":"AI > Billing","count":27},{"language":"default","tag":"Quotes","count":25},{"language":"default","tag":"Customers","count":20},{"language":"default","tag":"Guides","count":20},{"language":"default","tag":"Changelog","count":17}]},"assistantConfig":{"enableStarterQuestions":false,"deflection":{"enabled":true,"email":"support@hyperline.co","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"index.css","content":"a[href*=\"mintlify.com\"]{display:none;visibility:hidden}.text-2xl{font-weight:600}.tag-blue{height:20px;line-height:20px;display:inline-block;background:#93c5fd;margin:0;padding:0 6px;border-radius:4px;color:#0166ff;border:1px solid #0166ff;font-weight:600;font-size:12px}.tag-orange{height:20px;line-height:20px;display:inline-block;background:#fef9e0;margin:0;padding:0 6px;border-radius:4px;color:#da9e09;border:1px solid #da9e09;font-weight:600;font-size:12px}#footer>div>div:not(:first-child){display:none;visibility:hidden}"},{"filePath":"developers/getting-started.css","content":"#content-area:has(#developer-home){max-width:56rem;margin-inline:auto}"}],"page":{"pagePath":"api-reference/endpoints/accounting->-rules/get-accounting-rule-tree","slug":"/api-reference/endpoints/accounting->-rules/get-accounting-rule-tree","pageMetadata":{"openapi":"get /v1/accounting/rules/tree","title":"Get accounting rule tree","description":"Retrieve accounting rules organized as a filter tree. Accounting software sync rules are excluded.","href":"/api-reference/endpoints/accounting->-rules/get-accounting-rule-tree"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve accounting rules organized as a filter tree. Accounting software sync rules are excluded.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /v1/accounting/rules/tree","title":"Get accounting rule tree","description":"Retrieve accounting rules organized as a filter tree. Accounting software sync rules are excluded.","href":"/api-reference/endpoints/accounting->-rules/get-accounting-rule-tree"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getAccountingRuleTree","tags":["Accounting > Rules"],"security":["bca8d876-f529-4262-96b6-2d3fc1ecff2e"],"summary":"Get accounting rule tree","description":"Retrieve accounting rules organized as a filter tree. Accounting software sync rules are excluded.","parameters":["bbd4e882-71e3-482c-a49b-3fa4ed1029c8","d7bd4527-93e9-401e-b870-c8b94e9a792b","2bffc16f-1635-4730-87eb-99492f0823fd","c21b88ad-3307-450c-b31c-176ccaeed58b"],"responses":{"200":"d3f76106-732e-4365-879c-39af51f1510b"},"method":"get","type":"path","servers":["9970eff5-d5b2-4bb3-ad06-f292ffbb5d12","f551464f-8632-4fc5-b7e5-751f3c2f7471"],"path":"/v1/accounting/rules/tree","baseUrlOptions":["https://api.hyperline.co","https://sandbox.api.hyperline.co"],"title":"Get accounting rule tree","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"bbd4e882-71e3-482c-a49b-3fa4ed1029c8":{"schema":{"type":"string","description":"Ledger identifier.","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"Ledger identifier.","name":"ledger_id","in":"query"},"d7bd4527-93e9-401e-b870-c8b94e9a792b":{"schema":{"type":"string","description":"Optional invoicing entity identifier.","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Optional invoicing entity identifier.","name":"invoicing_entity_id","in":"query"},"2bffc16f-1635-4730-87eb-99492f0823fd":{"schema":{"oneOf":[{"type":"number","description":"Maximum tree depth to return.","uniqueKey":"oneOf.0","typeLabel":"number"},{"type":"null","description":"Maximum tree depth to return.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"},"required":false,"description":"Maximum tree depth to return.","name":"max_depth","in":"query"},"c21b88ad-3307-450c-b31c-176ccaeed58b":{"schema":{"type":"string","description":"Search by rule identifier or category.","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Search by rule identifier or category.","name":"search","in":"query"}},"responses":{"d3f76106-732e-4365-879c-39af51f1510b":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["category","filter","rule"],"description":"Type of tree node.","isRequired":true,"uniqueKey":"data.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"label":{"type":"string","description":"Display label of the node.","isRequired":true,"uniqueKey":"data.items.[INDEX].label","typeLabel":"string"},"depth":{"type":"number","description":"Depth of the node in the tree.","isRequired":true,"uniqueKey":"data.items.[INDEX].depth","typeLabel":"number"},"children":{"type":"array","description":"Child nodes.","items":{"$circularRef":"d832b2a3-2df9-4ec2-9367-23fcef1ec419"},"isRequired":true,"uniqueKey":"data.items.[INDEX].children","typeLabel":"array"},"category":{"oneOf":[{"type":"string","enum":["invoice_posted","invoice_settled","revenue_recognition","credit_note_created","accounting_software"],"description":"Accounting category represented by the node.","uniqueKey":"data.items.[INDEX].category.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["invoice_posted","invoice_settled","revenue_recognition","credit_note_created","accounting_software"],"description":"Accounting category represented by the node.","uniqueKey":"data.items.[INDEX].category.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].category","typeLabel":"enum\u003cstring> | null"},"filter_key":{"type":"string","description":"Filter field represented by the node.","uniqueKey":"data.items.[INDEX].filter_key","typeLabel":"string"},"filter_value":{"type":"string","description":"Raw filter value represented by the node.","uniqueKey":"data.items.[INDEX].filter_value","typeLabel":"string"},"filter_display_value":{"type":"string","description":"Display value of the represented filter.","uniqueKey":"data.items.[INDEX].filter_display_value","typeLabel":"string"},"rule_count":{"type":"number","description":"Number of rules below the node.","uniqueKey":"data.items.[INDEX].rule_count","typeLabel":"number"},"rule":{"type":"object","description":"Accounting rule represented by a rule node.","required":["id","code","name","ledger_id","category","priority","product_ids","product_types","customer_ids","currencies","countries","tax_schemes","tax_territories","tax_rate_classes","coupon_ids","client_provider_ids","payment_method_types","bank_account_ids","invoice_types","interval_period","interval_count","custom_property_filters","revenue_ledger_account_id","deferred_revenue_ledger_account_id","deferred_discount_ledger_account_id","contra_revenue_ledger_account_id","discount_ledger_account_id","ar_ledger_account_id","cash_ledger_account_id","payments_clearing_ledger_account_id","output_tax_ledger_account_id","uncollectible_debit_ledger_account_id","allowance_for_doubtful_accounts_id","provider_fees_expense_ledger_account_id","payment_processing_fees_expense_ledger_account_id","payment_processing_fees_revenue_ledger_account_id","customer_credits_ledger_account_id","rev_rec_method","rev_rec_granularity","rev_rec_point_in_time_basis","discount_recognition_method","journal_id","entity_type","created_at","updated_at"],"properties":{"id":{"type":"string","description":"Unique identifier of the accounting rule.","example":"arl_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.id","typeLabel":"string"},"code":{"type":"string","description":"Auto-generated rule code (e.g. R-001).","example":"R-001","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.code","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"Optional user-defined name for the rule.","example":"Recurring subscriptions","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional user-defined name for the rule.","example":"Recurring subscriptions","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.name","typeLabel":"string | null"},"ledger_id":{"type":"string","description":"Identifier of the ledger this rule belongs to.","example":"led_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.ledger_id","typeLabel":"string"},"category":{"oneOf":[{"type":"string","description":"Rule category (e.g. accounting_software, invoice_posted).","example":"accounting_software","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.category.oneOf.0","typeLabel":"string"},{"type":"null","description":"Rule category (e.g. accounting_software, invoice_posted).","example":"accounting_software","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.category.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.category","typeLabel":"string | null"},"priority":{"type":"number","description":"Override order. Higher priority wins when multiple rules match.","example":100,"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.priority","typeLabel":"number"},"product_ids":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].rule.product_ids.items.[INDEX]","typeLabel":"string"},"description":"Product IDs to match. Empty means match all.","example":["prod_abc123def456"],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.product_ids","typeLabel":"string[]"},"product_types":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].rule.product_types.items.[INDEX]","typeLabel":"string"},"description":"Product types to match. Allowed values: flat_fee, dynamic, seat, credit. Empty means match all.","example":["flat_fee"],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.product_types","typeLabel":"string[]"},"customer_ids":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].rule.customer_ids.items.[INDEX]","typeLabel":"string"},"description":"Customer IDs for customer-specific overrides.","example":["cus_abc123def456"],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.customer_ids","typeLabel":"string[]"},"currencies":{"type":"array","items":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR","uniqueKey":"data.items.[INDEX].rule.currencies.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Currency codes to match (e.g. EUR, USD).","example":["EUR"],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.currencies","typeLabel":"enum\u003cstring>[]"},"countries":{"type":"array","items":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BF","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ES-CE","ES-ML","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PT-20","PT-30","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Two-letter country code in ISO format. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","example":"FR","uniqueKey":"data.items.[INDEX].rule.countries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Country codes for jurisdiction-based overrides.","example":["FR"],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.countries","typeLabel":"enum\u003cstring>[]"},"tax_schemes":{"type":"array","items":{"type":"string","enum":["standard","reverse_charge","exempt","not_eligible","manual"],"uniqueKey":"data.items.[INDEX].rule.tax_schemes.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Tax schemes to match. A context without a tax scheme never matches a rule that sets this filter. Empty means match all.","example":["reverse_charge"],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.tax_schemes","typeLabel":"enum\u003cstring>[]"},"tax_territories":{"type":"array","items":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BF","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ES-CE","ES-ML","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PT-20","PT-30","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Two-letter country code in ISO format. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","example":"FR","uniqueKey":"data.items.[INDEX].rule.tax_territories.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Tax territory country codes to match. A context without a tax territory never matches a rule that sets this filter. Empty means match all.","example":["FR"],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.tax_territories","typeLabel":"enum\u003cstring>[]"},"tax_rate_classes":{"type":"array","items":{"type":"string","enum":["standard_rate","reduced_rate","reduced_rate_alt","super_reduced_rate","parking_rate","exempt","reverse_charge"],"uniqueKey":"data.items.[INDEX].rule.tax_rate_classes.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Tax rate classes to match. A context without a tax rate class never matches a rule that sets this filter. Empty means match all.","example":["standard_rate"],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.tax_rate_classes","typeLabel":"enum\u003cstring>[]"},"coupon_ids":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].rule.coupon_ids.items.[INDEX]","typeLabel":"string"},"description":"Coupon IDs to match. Empty means match all.","example":["cpn_abc123def456"],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.coupon_ids","typeLabel":"string[]"},"client_provider_ids":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].rule.client_provider_ids.items.[INDEX]","typeLabel":"string"},"description":"Client provider IDs to match. Empty means match all.","example":["clp_abc123def456"],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.client_provider_ids","typeLabel":"string[]"},"payment_method_types":{"type":"array","items":{"type":"string","enum":["card","transfer","transfer_automated","direct_debit","direct_debit_ach","direct_debit_bacs","apple_pay","google_pay","paypal","stripe_link","external"],"uniqueKey":"data.items.[INDEX].rule.payment_method_types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Payment method types to match. Empty means match all.","example":["card"],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.payment_method_types","typeLabel":"enum\u003cstring>[]"},"bank_account_ids":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].rule.bank_account_ids.items.[INDEX]","typeLabel":"string"},"description":"Bank account IDs to match. Empty means match all.","example":["bac_abc123def456"],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.bank_account_ids","typeLabel":"string[]"},"invoice_types":{"type":"array","items":{"type":"string","enum":["invoice","document"],"uniqueKey":"data.items.[INDEX].rule.invoice_types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Invoice kinds to match: `invoice` or `document`. Refunds and other standard invoices match as `invoice`. A context without an invoice, such as a PSP payout, never matches a rule that sets this filter. Empty means match all.","example":["document"],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.invoice_types","typeLabel":"enum\u003cstring>[]"},"interval_period":{"oneOf":[{"type":"string","enum":["days","weeks","quarters","months","years","once","all","recurring"],"description":"Billing interval period filter (months, years, etc.). `recurring` matches every interval except `once` and requires a null `interval_count`. `null` matches every interval, including `once`.","example":"months","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.interval_period.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["days","weeks","quarters","months","years","once","all","recurring"],"description":"Billing interval period filter (months, years, etc.). `recurring` matches every interval except `once` and requires a null `interval_count`. `null` matches every interval, including `once`.","example":"months","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.interval_period.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.interval_period","typeLabel":"enum\u003cstring> | null"},"interval_count":{"oneOf":[{"type":"number","description":"Billing interval count filter.","example":1,"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.interval_count.oneOf.0","typeLabel":"number"},{"type":"null","description":"Billing interval count filter.","example":1,"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.interval_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.interval_count","typeLabel":"number | null"},"custom_property_filters":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string","description":"Slug of an invoice custom property.","example":"fee_type","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.custom_property_filters.items.[INDEX].slug","typeLabel":"string"},"values":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].rule.custom_property_filters.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Values of the custom property to match, as strings. For `select` and `multi_select` they must be authorized values; a number or boolean is its string form (e.g. `12`, `true`), a date its UTC ISO timestamp, matched on the exact same instant. The filter matches when the invoice holds any of them.","example":["service"],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.custom_property_filters.items.[INDEX].values","typeLabel":"string[]"}},"required":["slug","values"],"uniqueKey":"data.items.[INDEX].rule.custom_property_filters.items.[INDEX]","typeLabel":"object"},"description":"Invoice custom property filters. A rule matches only when every entry matches (AND across entries), and an entry matches when the invoice value is one of its `values` (any-of). Matching is strict: an invoice without a value for the property never matches. Each entry adds 10 to the `suggested_priority` returned by the rule defaults endpoint. Allowed on invoice_posted, invoice_settled, revenue_recognition, credit_note_created and accounting_software (invoice side) rules. An invoice_settled rule with filters cannot set `payments_clearing_ledger_account_id`, as PSP payouts are booked without the invoice. Empty means match all.","example":[{"slug":"fee_type","values":["service"]}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.custom_property_filters","typeLabel":"object[]"},"revenue_ledger_account_id":{"oneOf":[{"type":"string","description":"Revenue ledger account ID used for invoice line revenue routing.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Revenue ledger account ID used for invoice line revenue routing.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account_id","typeLabel":"string | null"},"deferred_revenue_ledger_account_id":{"oneOf":[{"type":"string","description":"Deferred revenue ledger account ID used before revenue is recognized.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.deferred_revenue_ledger_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Deferred revenue ledger account ID used before revenue is recognized.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.deferred_revenue_ledger_account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.deferred_revenue_ledger_account_id","typeLabel":"string | null"},"deferred_discount_ledger_account_id":{"oneOf":[{"type":"string","description":"Deferred discount ledger account ID used before discounts are recognized.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.deferred_discount_ledger_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Deferred discount ledger account ID used before discounts are recognized.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.deferred_discount_ledger_account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.deferred_discount_ledger_account_id","typeLabel":"string | null"},"contra_revenue_ledger_account_id":{"oneOf":[{"type":"string","description":"Contra revenue ledger account ID used for amounts that reduce revenue.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.contra_revenue_ledger_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Contra revenue ledger account ID used for amounts that reduce revenue.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.contra_revenue_ledger_account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.contra_revenue_ledger_account_id","typeLabel":"string | null"},"discount_ledger_account_id":{"oneOf":[{"type":"string","description":"Discount ledger account ID used for recognized discounts.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.discount_ledger_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Discount ledger account ID used for recognized discounts.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.discount_ledger_account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.discount_ledger_account_id","typeLabel":"string | null"},"ar_ledger_account_id":{"oneOf":[{"type":"string","description":"Accounts receivable ledger account ID used for invoice posting.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.ar_ledger_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Accounts receivable ledger account ID used for invoice posting.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.ar_ledger_account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.ar_ledger_account_id","typeLabel":"string | null"},"cash_ledger_account_id":{"oneOf":[{"type":"string","description":"Cash ledger account ID used for payment settlement.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.cash_ledger_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cash ledger account ID used for payment settlement.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.cash_ledger_account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.cash_ledger_account_id","typeLabel":"string | null"},"payments_clearing_ledger_account_id":{"oneOf":[{"type":"string","description":"Payments clearing ledger account ID used while payments settle.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.payments_clearing_ledger_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Payments clearing ledger account ID used while payments settle.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.payments_clearing_ledger_account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.payments_clearing_ledger_account_id","typeLabel":"string | null"},"output_tax_ledger_account_id":{"oneOf":[{"type":"string","description":"Output tax ledger account ID used for tax liability.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.output_tax_ledger_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Output tax ledger account ID used for tax liability.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.output_tax_ledger_account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.output_tax_ledger_account_id","typeLabel":"string | null"},"uncollectible_debit_ledger_account_id":{"oneOf":[{"type":"string","description":"Ledger account ID debited when an invoice becomes uncollectible. Use an asset account for doubtful-receivable reclassification or an expense account for direct write-off.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.uncollectible_debit_ledger_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Ledger account ID debited when an invoice becomes uncollectible. Use an asset account for doubtful-receivable reclassification or an expense account for direct write-off.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.uncollectible_debit_ledger_account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.uncollectible_debit_ledger_account_id","typeLabel":"string | null"},"allowance_for_doubtful_accounts_id":{"oneOf":[{"type":"string","description":"Allowance for doubtful accounts ledger account ID, set on credit_note_created rules.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.allowance_for_doubtful_accounts_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Allowance for doubtful accounts ledger account ID, set on credit_note_created rules.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.allowance_for_doubtful_accounts_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.allowance_for_doubtful_accounts_id","typeLabel":"string | null"},"provider_fees_expense_ledger_account_id":{"oneOf":[{"type":"string","description":"Expense ledger account ID debited for payment provider fees when a payment settles.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.provider_fees_expense_ledger_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expense ledger account ID debited for payment provider fees when a payment settles.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.provider_fees_expense_ledger_account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.provider_fees_expense_ledger_account_id","typeLabel":"string | null"},"payment_processing_fees_expense_ledger_account_id":{"oneOf":[{"type":"string","description":"Expense ledger account ID debited for payment processing fees when a payment settles. Takes precedence over `provider_fees_expense_ledger_account_id` when set by the same or a higher priority rule.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.payment_processing_fees_expense_ledger_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expense ledger account ID debited for payment processing fees when a payment settles. Takes precedence over `provider_fees_expense_ledger_account_id` when set by the same or a higher priority rule.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.payment_processing_fees_expense_ledger_account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.payment_processing_fees_expense_ledger_account_id","typeLabel":"string | null"},"payment_processing_fees_revenue_ledger_account_id":{"oneOf":[{"type":"string","description":"Payment processing fees revenue ledger account ID, set on invoice_settled rules.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.payment_processing_fees_revenue_ledger_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Payment processing fees revenue ledger account ID, set on invoice_settled rules.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.payment_processing_fees_revenue_ledger_account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.payment_processing_fees_revenue_ledger_account_id","typeLabel":"string | null"},"customer_credits_ledger_account_id":{"oneOf":[{"type":"string","description":"Customer credits ledger account ID used for credit balances.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.customer_credits_ledger_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer credits ledger account ID used for credit balances.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.customer_credits_ledger_account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.customer_credits_ledger_account_id","typeLabel":"string | null"},"rev_rec_method":{"oneOf":[{"type":"string","enum":["none","point_in_time","over_time","usage_based","milestone","manual"],"description":"Revenue recognition method.","example":"over_time","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.rev_rec_method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["none","point_in_time","over_time","usage_based","milestone","manual"],"description":"Revenue recognition method.","example":"over_time","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.rev_rec_method.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.rev_rec_method","typeLabel":"enum\u003cstring> | null"},"rev_rec_granularity":{"oneOf":[{"type":"string","enum":["day","month","quarter","year"],"description":"Recognition period granularity. Used when `rev_rec_method` is `over_time`.","example":"month","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.rev_rec_granularity.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["day","month","quarter","year"],"description":"Recognition period granularity. Used when `rev_rec_method` is `over_time`.","example":"month","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.rev_rec_granularity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.rev_rec_granularity","typeLabel":"enum\u003cstring> | null"},"rev_rec_point_in_time_basis":{"oneOf":[{"type":"string","enum":["invoice_date","service_start_date","service_end_date","custom_date"],"description":"Date revenue is recognized on. Used when `rev_rec_method` is `point_in_time`.","example":"service_end_date","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.rev_rec_point_in_time_basis.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["invoice_date","service_start_date","service_end_date","custom_date"],"description":"Date revenue is recognized on. Used when `rev_rec_method` is `point_in_time`.","example":"service_end_date","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.rev_rec_point_in_time_basis.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.rev_rec_point_in_time_basis","typeLabel":"enum\u003cstring> | null"},"discount_recognition_method":{"oneOf":[{"type":"string","enum":["immediate","deferred","use_net_amount"],"description":"Method used to recognize discounts.","example":"deferred","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.discount_recognition_method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["immediate","deferred","use_net_amount"],"description":"Method used to recognize discounts.","example":"deferred","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.discount_recognition_method.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.discount_recognition_method","typeLabel":"enum\u003cstring> | null"},"journal_id":{"oneOf":[{"type":"string","description":"Journal ID used to route entries in the accounting provider.","example":"jou_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.journal_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Journal ID used to route entries in the accounting provider.","example":"jou_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.journal_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.journal_id","typeLabel":"string | null"},"entity_type":{"oneOf":[{"type":"string","description":"Entity type the rule applies to.","example":"invoice","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.entity_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Entity type the rule applies to.","example":"invoice","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.entity_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.entity_type","typeLabel":"string | null"},"created_at":{"type":"string","format":"date","description":"Timestamp when the rule was created.","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.created_at","typeLabel":"string\u003cdate>"},"updated_at":{"type":"string","format":"date","description":"Timestamp when the rule was last updated.","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.updated_at","typeLabel":"string\u003cdate>"},"revenue_ledger_account":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the ledger account.","example":"lac_abc123def456","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.0.id","typeLabel":"string"},"code":{"type":"string","description":"Accounting code of the ledger account.","example":"706100","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.0.code","typeLabel":"string"},"name":{"type":"string","description":"Display name of the ledger account.","example":"Revenue","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.0.name","typeLabel":"string"},"integration":{"oneOf":[{"type":"object","properties":{"entity_id":{"type":"string","description":"ID of the entity in the provider.","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.0.integration.oneOf.0.entity_id","typeLabel":"string"},"provider_name":{"type":"string","enum":["adyen","stripe","mollie","gocardless","airwallex","salesforce","hubspot","attio","xero","pennylane","zoho-books","exact-online","quickbooks","netsuite","rillet","campfire","dualentry","datev","anrok","sphere","chargebee","slack","plain","zendesk","pylon","intercom","front","helpscout","claap","grain","gong","jiminny","modjo","posthog"],"description":"Provider name.","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.0.integration.oneOf.0.provider_name","typeLabel":"enum\u003cstring>"},"provider_account_id":{"type":"string","description":"ID of the connected provider account.","isRequired":true,"uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.0.integration.oneOf.0.provider_account_id","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.0.integration.oneOf.0.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.0.integration.oneOf.0.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.0.integration.oneOf.0.created_at","typeLabel":"string\u003cdate-time> | null"},"activated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.0.integration.oneOf.0.activated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.0.integration.oneOf.0.activated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.0.integration.oneOf.0.activated_at","typeLabel":"string\u003cdate-time> | null"}},"required":["entity_id","provider_name","provider_account_id"],"description":"External provider reference associated with the ledger account.","example":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"},"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.0.integration.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"entity_id":{"type":"string","description":"ID of the entity in the provider."},"provider_name":{"type":"string","enum":["adyen","stripe","mollie","gocardless","airwallex","salesforce","hubspot","attio","xero","pennylane","zoho-books","exact-online","quickbooks","netsuite","rillet","campfire","dualentry","datev","anrok","sphere","chargebee","slack","plain","zendesk","pylon","intercom","front","helpscout","claap","grain","gong","jiminny","modjo","posthog"],"description":"Provider name."},"provider_account_id":{"type":"string","description":"ID of the connected provider account."},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z"},{"type":"null","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z"}]},"activated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z"},{"type":"null","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z"}]}},"required":["entity_id","provider_name","provider_account_id"],"description":"External provider reference associated with the ledger account.","example":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"},"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.0.integration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.0.integration","typeLabel":"object | null"}},"required":["id","code","name","integration"],"description":"Expanded revenue ledger account reference when available.","uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","description":"Unique identifier of the ledger account.","example":"lac_abc123def456"},"code":{"type":"string","description":"Accounting code of the ledger account.","example":"706100"},"name":{"type":"string","description":"Display name of the ledger account.","example":"Revenue"},"integration":{"oneOf":[{"type":"object","properties":{"entity_id":{"type":"string","description":"ID of the entity in the provider."},"provider_name":{"type":"string","enum":["adyen","stripe","mollie","gocardless","airwallex","salesforce","hubspot","attio","xero","pennylane","zoho-books","exact-online","quickbooks","netsuite","rillet","campfire","dualentry","datev","anrok","sphere","chargebee","slack","plain","zendesk","pylon","intercom","front","helpscout","claap","grain","gong","jiminny","modjo","posthog"],"description":"Provider name."},"provider_account_id":{"type":"string","description":"ID of the connected provider account."},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z"},{"type":"null","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z"}]},"activated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z"},{"type":"null","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z"}]}},"required":["entity_id","provider_name","provider_account_id"],"description":"External provider reference associated with the ledger account.","example":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"}},{"type":"null","properties":{"entity_id":{"type":"string","description":"ID of the entity in the provider."},"provider_name":{"type":"string","enum":["adyen","stripe","mollie","gocardless","airwallex","salesforce","hubspot","attio","xero","pennylane","zoho-books","exact-online","quickbooks","netsuite","rillet","campfire","dualentry","datev","anrok","sphere","chargebee","slack","plain","zendesk","pylon","intercom","front","helpscout","claap","grain","gong","jiminny","modjo","posthog"],"description":"Provider name."},"provider_account_id":{"type":"string","description":"ID of the connected provider account."},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z"},{"type":"null","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z"}]},"activated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z"},{"type":"null","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z"}]}},"required":["entity_id","provider_name","provider_account_id"],"description":"External provider reference associated with the ledger account.","example":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"}}]}},"required":["id","code","name","integration"],"description":"Expanded revenue ledger account reference when available.","uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].rule.revenue_ledger_account","typeLabel":"object | null"}},"uniqueKey":"data.items.[INDEX].rule","typeLabel":"object"}},"required":["type","label","depth","children"],"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"description":"Hierarchical accounting rule tree.","isRequired":true,"uniqueKey":"data","typeLabel":"object[]"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":[{"type":"category","label":"\u003cstring>","depth":123,"children":"\u003carray>","category":"invoice_posted","filter_key":"\u003cstring>","filter_value":"\u003cstring>","filter_display_value":"\u003cstring>","rule_count":123,"rule":{"id":"arl_abc123def456","code":"R-001","name":"Recurring subscriptions","ledger_id":"led_abc123def456","category":"accounting_software","priority":100,"product_ids":["prod_abc123def456"],"product_types":["flat_fee"],"customer_ids":["cus_abc123def456"],"currencies":["EUR"],"countries":["FR"],"tax_schemes":["reverse_charge"],"tax_territories":["FR"],"tax_rate_classes":["standard_rate"],"coupon_ids":["cpn_abc123def456"],"client_provider_ids":["clp_abc123def456"],"payment_method_types":["card"],"bank_account_ids":["bac_abc123def456"],"invoice_types":["document"],"interval_period":"months","interval_count":1,"custom_property_filters":[{"slug":"fee_type","values":["service"]}],"revenue_ledger_account_id":"lac_abc123def456","deferred_revenue_ledger_account_id":"lac_abc123def456","deferred_discount_ledger_account_id":"lac_abc123def456","contra_revenue_ledger_account_id":"lac_abc123def456","discount_ledger_account_id":"lac_abc123def456","ar_ledger_account_id":"lac_abc123def456","cash_ledger_account_id":"lac_abc123def456","payments_clearing_ledger_account_id":"lac_abc123def456","output_tax_ledger_account_id":"lac_abc123def456","uncollectible_debit_ledger_account_id":"lac_abc123def456","allowance_for_doubtful_accounts_id":"lac_abc123def456","provider_fees_expense_ledger_account_id":"lac_abc123def456","payment_processing_fees_expense_ledger_account_id":"lac_abc123def456","payment_processing_fees_revenue_ledger_account_id":"lac_abc123def456","customer_credits_ledger_account_id":"lac_abc123def456","rev_rec_method":"over_time","rev_rec_granularity":"month","rev_rec_point_in_time_basis":"service_end_date","discount_recognition_method":"deferred","journal_id":"jou_abc123def456","entity_type":"invoice","created_at":"2023-12-25","updated_at":"2023-12-25","revenue_ledger_account":{"id":"lac_abc123def456","code":"706100","name":"Revenue","integration":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"}}}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"bca8d876-f529-4262-96b6-2d3fc1ecff2e":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearer"}}},"servers":{"9970eff5-d5b2-4bb3-ad06-f292ffbb5d12":{"url":"https://api.hyperline.co"},"f551464f-8632-4fc5-b7e5-751f3c2f7471":{"url":"https://sandbox.api.hyperline.co"}},"schemas":{"d832b2a3-2df9-4ec2-9367-23fcef1ec419":{"type":"object","properties":{"type":{"type":"string","enum":["category","filter","rule"],"description":"Type of tree node.","isRequired":true},"label":{"type":"string","description":"Display label of the node.","isRequired":true},"depth":{"type":"number","description":"Depth of the node in the tree.","isRequired":true},"children":{"type":"array","description":"Child nodes.","items":{"$circularRef":"d832b2a3-2df9-4ec2-9367-23fcef1ec419"},"isRequired":true},"category":{"oneOf":[{"type":"string","description":"Accounting category represented by the node.","enum":["invoice_posted","invoice_settled","revenue_recognition","credit_note_created","accounting_software"]},{"type":"null","description":"Accounting category represented by the node.","enum":["invoice_posted","invoice_settled","revenue_recognition","credit_note_created","accounting_software"]}]},"filter_key":{"type":"string","description":"Filter field represented by the node."},"filter_value":{"type":"string","description":"Raw filter value represented by the node."},"filter_display_value":{"type":"string","description":"Display value of the represented filter."},"rule_count":{"type":"number","description":"Number of rules below the node."},"rule":{"type":"object","description":"Accounting rule represented by a rule node.","required":["id","code","name","ledger_id","category","priority","product_ids","product_types","customer_ids","currencies","countries","tax_schemes","tax_territories","tax_rate_classes","coupon_ids","client_provider_ids","payment_method_types","bank_account_ids","invoice_types","interval_period","interval_count","custom_property_filters","revenue_ledger_account_id","deferred_revenue_ledger_account_id","deferred_discount_ledger_account_id","contra_revenue_ledger_account_id","discount_ledger_account_id","ar_ledger_account_id","cash_ledger_account_id","payments_clearing_ledger_account_id","output_tax_ledger_account_id","uncollectible_debit_ledger_account_id","allowance_for_doubtful_accounts_id","provider_fees_expense_ledger_account_id","payment_processing_fees_expense_ledger_account_id","payment_processing_fees_revenue_ledger_account_id","customer_credits_ledger_account_id","rev_rec_method","rev_rec_granularity","rev_rec_point_in_time_basis","discount_recognition_method","journal_id","entity_type","created_at","updated_at"],"properties":{"id":{"type":"string","description":"Unique identifier of the accounting rule.","example":"arl_abc123def456","isRequired":true},"code":{"type":"string","description":"Auto-generated rule code (e.g. R-001).","example":"R-001","isRequired":true},"name":{"oneOf":[{"type":"string","description":"Optional user-defined name for the rule.","example":"Recurring subscriptions","isRequired":true},{"type":"null","description":"Optional user-defined name for the rule.","example":"Recurring subscriptions","isRequired":true}],"isRequired":true},"ledger_id":{"type":"string","description":"Identifier of the ledger this rule belongs to.","example":"led_abc123def456","isRequired":true},"category":{"oneOf":[{"type":"string","description":"Rule category (e.g. accounting_software, invoice_posted).","example":"accounting_software","isRequired":true},{"type":"null","description":"Rule category (e.g. accounting_software, invoice_posted).","example":"accounting_software","isRequired":true}],"isRequired":true},"priority":{"type":"number","description":"Override order. Higher priority wins when multiple rules match.","example":100,"isRequired":true},"product_ids":{"type":"array","items":{"type":"string"},"description":"Product IDs to match. Empty means match all.","example":["prod_abc123def456"],"isRequired":true},"product_types":{"type":"array","items":{"type":"string"},"description":"Product types to match. Allowed values: flat_fee, dynamic, seat, credit. Empty means match all.","example":["flat_fee"],"isRequired":true},"customer_ids":{"type":"array","items":{"type":"string"},"description":"Customer IDs for customer-specific overrides.","example":["cus_abc123def456"],"isRequired":true},"currencies":{"type":"array","items":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR"},"description":"Currency codes to match (e.g. EUR, USD).","example":["EUR"],"isRequired":true},"countries":{"type":"array","items":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BF","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ES-CE","ES-ML","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PT-20","PT-30","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Two-letter country code in ISO format. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","example":"FR"},"description":"Country codes for jurisdiction-based overrides.","example":["FR"],"isRequired":true},"tax_schemes":{"type":"array","items":{"type":"string","enum":["standard","reverse_charge","exempt","not_eligible","manual"]},"description":"Tax schemes to match. A context without a tax scheme never matches a rule that sets this filter. Empty means match all.","example":["reverse_charge"],"isRequired":true},"tax_territories":{"type":"array","items":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BF","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ES-CE","ES-ML","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PT-20","PT-30","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Two-letter country code in ISO format. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","example":"FR"},"description":"Tax territory country codes to match. A context without a tax territory never matches a rule that sets this filter. Empty means match all.","example":["FR"],"isRequired":true},"tax_rate_classes":{"type":"array","items":{"type":"string","enum":["standard_rate","reduced_rate","reduced_rate_alt","super_reduced_rate","parking_rate","exempt","reverse_charge"]},"description":"Tax rate classes to match. A context without a tax rate class never matches a rule that sets this filter. Empty means match all.","example":["standard_rate"],"isRequired":true},"coupon_ids":{"type":"array","items":{"type":"string"},"description":"Coupon IDs to match. Empty means match all.","example":["cpn_abc123def456"],"isRequired":true},"client_provider_ids":{"type":"array","items":{"type":"string"},"description":"Client provider IDs to match. Empty means match all.","example":["clp_abc123def456"],"isRequired":true},"payment_method_types":{"type":"array","items":{"type":"string","enum":["card","transfer","transfer_automated","direct_debit","direct_debit_ach","direct_debit_bacs","apple_pay","google_pay","paypal","stripe_link","external"]},"description":"Payment method types to match. Empty means match all.","example":["card"],"isRequired":true},"bank_account_ids":{"type":"array","items":{"type":"string"},"description":"Bank account IDs to match. Empty means match all.","example":["bac_abc123def456"],"isRequired":true},"invoice_types":{"type":"array","items":{"type":"string","enum":["invoice","document"]},"description":"Invoice kinds to match: `invoice` or `document`. Refunds and other standard invoices match as `invoice`. A context without an invoice, such as a PSP payout, never matches a rule that sets this filter. Empty means match all.","example":["document"],"isRequired":true},"interval_period":{"oneOf":[{"type":"string","description":"Billing interval period filter (months, years, etc.). `recurring` matches every interval except `once` and requires a null `interval_count`. `null` matches every interval, including `once`.","enum":["days","weeks","quarters","months","years","once","all","recurring"],"example":"months","isRequired":true},{"type":"null","description":"Billing interval period filter (months, years, etc.). `recurring` matches every interval except `once` and requires a null `interval_count`. `null` matches every interval, including `once`.","enum":["days","weeks","quarters","months","years","once","all","recurring"],"example":"months","isRequired":true}],"isRequired":true},"interval_count":{"oneOf":[{"type":"number","description":"Billing interval count filter.","example":1,"isRequired":true},{"type":"null","description":"Billing interval count filter.","example":1,"isRequired":true}],"isRequired":true},"custom_property_filters":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string","description":"Slug of an invoice custom property.","example":"fee_type","isRequired":true},"values":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Values of the custom property to match, as strings. For `select` and `multi_select` they must be authorized values; a number or boolean is its string form (e.g. `12`, `true`), a date its UTC ISO timestamp, matched on the exact same instant. The filter matches when the invoice holds any of them.","example":["service"],"isRequired":true}},"required":["slug","values"]},"description":"Invoice custom property filters. A rule matches only when every entry matches (AND across entries), and an entry matches when the invoice value is one of its `values` (any-of). Matching is strict: an invoice without a value for the property never matches. Each entry adds 10 to the `suggested_priority` returned by the rule defaults endpoint. Allowed on invoice_posted, invoice_settled, revenue_recognition, credit_note_created and accounting_software (invoice side) rules. An invoice_settled rule with filters cannot set `payments_clearing_ledger_account_id`, as PSP payouts are booked without the invoice. Empty means match all.","example":[{"slug":"fee_type","values":["service"]}],"isRequired":true},"revenue_ledger_account_id":{"oneOf":[{"type":"string","description":"Revenue ledger account ID used for invoice line revenue routing.","example":"lac_abc123def456","isRequired":true},{"type":"null","description":"Revenue ledger account ID used for invoice line revenue routing.","example":"lac_abc123def456","isRequired":true}],"isRequired":true},"deferred_revenue_ledger_account_id":{"oneOf":[{"type":"string","description":"Deferred revenue ledger account ID used before revenue is recognized.","example":"lac_abc123def456","isRequired":true},{"type":"null","description":"Deferred revenue ledger account ID used before revenue is recognized.","example":"lac_abc123def456","isRequired":true}],"isRequired":true},"deferred_discount_ledger_account_id":{"oneOf":[{"type":"string","description":"Deferred discount ledger account ID used before discounts are recognized.","example":"lac_abc123def456","isRequired":true},{"type":"null","description":"Deferred discount ledger account ID used before discounts are recognized.","example":"lac_abc123def456","isRequired":true}],"isRequired":true},"contra_revenue_ledger_account_id":{"oneOf":[{"type":"string","description":"Contra revenue ledger account ID used for amounts that reduce revenue.","example":"lac_abc123def456","isRequired":true},{"type":"null","description":"Contra revenue ledger account ID used for amounts that reduce revenue.","example":"lac_abc123def456","isRequired":true}],"isRequired":true},"discount_ledger_account_id":{"oneOf":[{"type":"string","description":"Discount ledger account ID used for recognized discounts.","example":"lac_abc123def456","isRequired":true},{"type":"null","description":"Discount ledger account ID used for recognized discounts.","example":"lac_abc123def456","isRequired":true}],"isRequired":true},"ar_ledger_account_id":{"oneOf":[{"type":"string","description":"Accounts receivable ledger account ID used for invoice posting.","example":"lac_abc123def456","isRequired":true},{"type":"null","description":"Accounts receivable ledger account ID used for invoice posting.","example":"lac_abc123def456","isRequired":true}],"isRequired":true},"cash_ledger_account_id":{"oneOf":[{"type":"string","description":"Cash ledger account ID used for payment settlement.","example":"lac_abc123def456","isRequired":true},{"type":"null","description":"Cash ledger account ID used for payment settlement.","example":"lac_abc123def456","isRequired":true}],"isRequired":true},"payments_clearing_ledger_account_id":{"oneOf":[{"type":"string","description":"Payments clearing ledger account ID used while payments settle.","example":"lac_abc123def456","isRequired":true},{"type":"null","description":"Payments clearing ledger account ID used while payments settle.","example":"lac_abc123def456","isRequired":true}],"isRequired":true},"output_tax_ledger_account_id":{"oneOf":[{"type":"string","description":"Output tax ledger account ID used for tax liability.","example":"lac_abc123def456","isRequired":true},{"type":"null","description":"Output tax ledger account ID used for tax liability.","example":"lac_abc123def456","isRequired":true}],"isRequired":true},"uncollectible_debit_ledger_account_id":{"oneOf":[{"type":"string","description":"Ledger account ID debited when an invoice becomes uncollectible. Use an asset account for doubtful-receivable reclassification or an expense account for direct write-off.","example":"lac_abc123def456","isRequired":true},{"type":"null","description":"Ledger account ID debited when an invoice becomes uncollectible. Use an asset account for doubtful-receivable reclassification or an expense account for direct write-off.","example":"lac_abc123def456","isRequired":true}],"isRequired":true},"allowance_for_doubtful_accounts_id":{"oneOf":[{"type":"string","description":"Allowance for doubtful accounts ledger account ID, set on credit_note_created rules.","example":"lac_abc123def456","isRequired":true},{"type":"null","description":"Allowance for doubtful accounts ledger account ID, set on credit_note_created rules.","example":"lac_abc123def456","isRequired":true}],"isRequired":true},"provider_fees_expense_ledger_account_id":{"oneOf":[{"type":"string","description":"Expense ledger account ID debited for payment provider fees when a payment settles.","example":"lac_abc123def456","isRequired":true},{"type":"null","description":"Expense ledger account ID debited for payment provider fees when a payment settles.","example":"lac_abc123def456","isRequired":true}],"isRequired":true},"payment_processing_fees_expense_ledger_account_id":{"oneOf":[{"type":"string","description":"Expense ledger account ID debited for payment processing fees when a payment settles. Takes precedence over `provider_fees_expense_ledger_account_id` when set by the same or a higher priority rule.","example":"lac_abc123def456","isRequired":true},{"type":"null","description":"Expense ledger account ID debited for payment processing fees when a payment settles. Takes precedence over `provider_fees_expense_ledger_account_id` when set by the same or a higher priority rule.","example":"lac_abc123def456","isRequired":true}],"isRequired":true},"payment_processing_fees_revenue_ledger_account_id":{"oneOf":[{"type":"string","description":"Payment processing fees revenue ledger account ID, set on invoice_settled rules.","example":"lac_abc123def456","isRequired":true},{"type":"null","description":"Payment processing fees revenue ledger account ID, set on invoice_settled rules.","example":"lac_abc123def456","isRequired":true}],"isRequired":true},"customer_credits_ledger_account_id":{"oneOf":[{"type":"string","description":"Customer credits ledger account ID used for credit balances.","example":"lac_abc123def456","isRequired":true},{"type":"null","description":"Customer credits ledger account ID used for credit balances.","example":"lac_abc123def456","isRequired":true}],"isRequired":true},"rev_rec_method":{"oneOf":[{"type":"string","description":"Revenue recognition method.","enum":["none","point_in_time","over_time","usage_based","milestone","manual"],"example":"over_time","isRequired":true},{"type":"null","description":"Revenue recognition method.","enum":["none","point_in_time","over_time","usage_based","milestone","manual"],"example":"over_time","isRequired":true}],"isRequired":true},"rev_rec_granularity":{"oneOf":[{"type":"string","description":"Recognition period granularity. Used when `rev_rec_method` is `over_time`.","enum":["day","month","quarter","year"],"example":"month","isRequired":true},{"type":"null","description":"Recognition period granularity. Used when `rev_rec_method` is `over_time`.","enum":["day","month","quarter","year"],"example":"month","isRequired":true}],"isRequired":true},"rev_rec_point_in_time_basis":{"oneOf":[{"type":"string","description":"Date revenue is recognized on. Used when `rev_rec_method` is `point_in_time`.","enum":["invoice_date","service_start_date","service_end_date","custom_date"],"example":"service_end_date","isRequired":true},{"type":"null","description":"Date revenue is recognized on. Used when `rev_rec_method` is `point_in_time`.","enum":["invoice_date","service_start_date","service_end_date","custom_date"],"example":"service_end_date","isRequired":true}],"isRequired":true},"discount_recognition_method":{"oneOf":[{"type":"string","description":"Method used to recognize discounts.","enum":["immediate","deferred","use_net_amount"],"example":"deferred","isRequired":true},{"type":"null","description":"Method used to recognize discounts.","enum":["immediate","deferred","use_net_amount"],"example":"deferred","isRequired":true}],"isRequired":true},"journal_id":{"oneOf":[{"type":"string","description":"Journal ID used to route entries in the accounting provider.","example":"jou_abc123def456","isRequired":true},{"type":"null","description":"Journal ID used to route entries in the accounting provider.","example":"jou_abc123def456","isRequired":true}],"isRequired":true},"entity_type":{"oneOf":[{"type":"string","description":"Entity type the rule applies to.","example":"invoice","isRequired":true},{"type":"null","description":"Entity type the rule applies to.","example":"invoice","isRequired":true}],"isRequired":true},"created_at":{"type":"string","format":"date","description":"Timestamp when the rule was created.","isRequired":true},"updated_at":{"type":"string","format":"date","description":"Timestamp when the rule was last updated.","isRequired":true},"revenue_ledger_account":{"oneOf":[{"type":"object","description":"Expanded revenue ledger account reference when available.","required":["id","code","name","integration"],"properties":{"id":{"type":"string","description":"Unique identifier of the ledger account.","example":"lac_abc123def456","isRequired":true},"code":{"type":"string","description":"Accounting code of the ledger account.","example":"706100","isRequired":true},"name":{"type":"string","description":"Display name of the ledger account.","example":"Revenue","isRequired":true},"integration":{"oneOf":[{"type":"object","description":"External provider reference associated with the ledger account.","required":["entity_id","provider_name","provider_account_id"],"example":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"},"properties":{"entity_id":{"type":"string","description":"ID of the entity in the provider.","isRequired":true},"provider_name":{"type":"string","enum":["adyen","stripe","mollie","gocardless","airwallex","salesforce","hubspot","attio","xero","pennylane","zoho-books","exact-online","quickbooks","netsuite","rillet","campfire","dualentry","datev","anrok","sphere","chargebee","slack","plain","zendesk","pylon","intercom","front","helpscout","claap","grain","gong","jiminny","modjo","posthog"],"description":"Provider name.","isRequired":true},"provider_account_id":{"type":"string","description":"ID of the connected provider account.","isRequired":true},"created_at":{"oneOf":[{"type":"string","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","format":"date-time","example":"2024-12-20T16:04:11Z"},{"type":"null","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","format":"date-time","example":"2024-12-20T16:04:11Z"}]},"activated_at":{"oneOf":[{"type":"string","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","format":"date-time","example":"2024-12-20T16:04:11Z"},{"type":"null","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","format":"date-time","example":"2024-12-20T16:04:11Z"}]}},"isRequired":true},{"type":"null","description":"External provider reference associated with the ledger account.","required":["entity_id","provider_name","provider_account_id"],"example":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"},"properties":{"entity_id":{"type":"string","description":"ID of the entity in the provider."},"provider_name":{"type":"string","enum":["adyen","stripe","mollie","gocardless","airwallex","salesforce","hubspot","attio","xero","pennylane","zoho-books","exact-online","quickbooks","netsuite","rillet","campfire","dualentry","datev","anrok","sphere","chargebee","slack","plain","zendesk","pylon","intercom","front","helpscout","claap","grain","gong","jiminny","modjo","posthog"],"description":"Provider name."},"provider_account_id":{"type":"string","description":"ID of the connected provider account."},"created_at":{"oneOf":[{"type":"string","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","format":"date-time","example":"2024-12-20T16:04:11Z"},{"type":"null","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","format":"date-time","example":"2024-12-20T16:04:11Z"}]},"activated_at":{"oneOf":[{"type":"string","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","format":"date-time","example":"2024-12-20T16:04:11Z"},{"type":"null","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","format":"date-time","example":"2024-12-20T16:04:11Z"}]}},"isRequired":true}],"isRequired":true}}},{"type":"null","description":"Expanded revenue ledger account reference when available.","required":["id","code","name","integration"],"properties":{"id":{"type":"string","description":"Unique identifier of the ledger account.","example":"lac_abc123def456"},"code":{"type":"string","description":"Accounting code of the ledger account.","example":"706100"},"name":{"type":"string","description":"Display name of the ledger account.","example":"Revenue"},"integration":{"oneOf":[{"type":"object","description":"External provider reference associated with the ledger account.","required":["entity_id","provider_name","provider_account_id"],"example":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"},"properties":{"entity_id":{"type":"string","description":"ID of the entity in the provider."},"provider_name":{"type":"string","enum":["adyen","stripe","mollie","gocardless","airwallex","salesforce","hubspot","attio","xero","pennylane","zoho-books","exact-online","quickbooks","netsuite","rillet","campfire","dualentry","datev","anrok","sphere","chargebee","slack","plain","zendesk","pylon","intercom","front","helpscout","claap","grain","gong","jiminny","modjo","posthog"],"description":"Provider name."},"provider_account_id":{"type":"string","description":"ID of the connected provider account."},"created_at":{"oneOf":[{"type":"string","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","format":"date-time","example":"2024-12-20T16:04:11Z"},{"type":"null","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","format":"date-time","example":"2024-12-20T16:04:11Z"}]},"activated_at":{"oneOf":[{"type":"string","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","format":"date-time","example":"2024-12-20T16:04:11Z"},{"type":"null","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","format":"date-time","example":"2024-12-20T16:04:11Z"}]}}},{"type":"null","description":"External provider reference associated with the ledger account.","required":["entity_id","provider_name","provider_account_id"],"example":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"},"properties":{"entity_id":{"type":"string","description":"ID of the entity in the provider."},"provider_name":{"type":"string","enum":["adyen","stripe","mollie","gocardless","airwallex","salesforce","hubspot","attio","xero","pennylane","zoho-books","exact-online","quickbooks","netsuite","rillet","campfire","dualentry","datev","anrok","sphere","chargebee","slack","plain","zendesk","pylon","intercom","front","helpscout","claap","grain","gong","jiminny","modjo","posthog"],"description":"Provider name."},"provider_account_id":{"type":"string","description":"ID of the connected provider account."},"created_at":{"oneOf":[{"type":"string","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","format":"date-time","example":"2024-12-20T16:04:11Z"},{"type":"null","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","format":"date-time","example":"2024-12-20T16:04:11Z"}]},"activated_at":{"oneOf":[{"type":"string","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","format":"date-time","example":"2024-12-20T16:04:11Z"},{"type":"null","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","format":"date-time","example":"2024-12-20T16:04:11Z"}]}}}]}}}]}}}},"required":["type","label","depth","children"]}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi-main.json"},"subdomain":"hyperline","siteName":"Hyperline","title":"Get accounting rule tree - Hyperline","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-06T08:02:44.760Z","originalFileLocation":"api-reference/endpoints/accounting->-rules/get-accounting-rule-tree.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve accounting rules organized as a filter tree. Accounting software sync rules are excluded.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hyperline\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get accounting rule tree - Hyperline\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve accounting rules organized as a filter tree. Accounting software sync rules are excluded.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hyperline\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hyperline.co/api-reference/endpoints/accounting-\u0026gt;-rules/get-accounting-rule-tree\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://app.hyperline.co/auth/background.svg\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get accounting rule tree - Hyperline\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve accounting rules organized as a filter tree. Accounting software sync rules are excluded.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://app.hyperline.co/auth/background.svg\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hyperline\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1A1A1A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hyperline.co/api-reference/endpoints/accounting-\u0026gt;-rules/get-accounting-rule-tree\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/accounting-%3E-rules/get-accounting-rule-tree.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hyperline.co/#organization\",\"name\":\"Hyperline\",\"url\":\"https://docs.hyperline.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hyperline/G-7ZQgHUOVHWwtUN/layout/logo-dark.png?fit=max\u0026auto=format\u0026n=G-7ZQgHUOVHWwtUN\u0026q=85\u0026s=2521f5f5ce4977d387d12aa169a8ee55\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hyperline.co#website\",\"name\":\"Hyperline\",\"url\":\"https://docs.hyperline.co\",\"publisher\":{\"@id\":\"https://docs.hyperline.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/accounting-%3E-rules/get-accounting-rule-tree#webpage\",\"url\":\"https://docs.hyperline.co/api-reference/endpoints/accounting-%3E-rules/get-accounting-rule-tree\",\"name\":\"Get accounting rule tree\",\"description\":\"Retrieve accounting rules organized as a filter tree. Accounting software sync rules are excluded.\",\"dateModified\":\"2026-10-06T08:02:44.760Z\",\"isPartOf\":{\"@id\":\"https://docs.hyperline.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/accounting-%3E-rules/get-accounting-rule-tree#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/accounting-%3E-rules/get-accounting-rule-tree#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Hyperline\",\"item\":\"https://docs.hyperline.co\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get accounting rule tree\",\"item\":\"https://docs.hyperline.co/api-reference/endpoints/accounting-%3E-rules/get-accounting-rule-tree\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/accounting-%3E-rules/get-accounting-rule-tree#apireference\",\"headline\":\"Get accounting rule tree\",\"name\":\"Get accounting rule tree\",\"description\":\"Retrieve accounting rules organized as a filter tree. Accounting software sync rules are excluded.\",\"url\":\"https://docs.hyperline.co/api-reference/endpoints/accounting-%3E-rules/get-accounting-rule-tree\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/accounting-%3E-rules/get-accounting-rule-tree#webpage\"},\"image\":\"https://app.hyperline.co/auth/background.svg\",\"dateModified\":\"2026-10-06T08:02:44.760Z\",\"publisher\":{\"@id\":\"https://docs.hyperline.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hyperline.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hyperline\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Hyperline","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/docs"}]},{"tab":"Developers","icon":"code","groups":[{"group":"Technical documentation","pages":[{"title":"Hyperline for developers","sidebarTitle":"Getting started","mode":"wide","href":"/developers/getting-started"},{"title":"Authentication","href":"/developers/authentication"}]},{"group":"API fundamentals","pages":[{"title":"Pagination and filtering","href":"/developers/pagination"},{"title":"Error handling","href":"/developers/error-handling"},{"title":"Rate limiting","href":"/developers/rate-limiting"},{"title":"Idempotent requests","href":"/developers/idempotent-requests"},{"title":"Currency amounts","href":"/developers/amount"},{"title":"Dates \u0026 timezones","href":"/developers/dates-and-timezones"},{"title":"API upgrades","href":"/developers/upgrades"}]},{"group":"AI / LLMs","pages":[{"title":"Build with LLMs","href":"/developers/ai/overview"},{"title":"Hyperline MCP","sidebarTitle":"MCP server","href":"/developers/ai/mcp"},{"title":"Hyperline CLI","sidebarTitle":"CLI","href":"/developers/ai/cli"}]},{"group":"Integrations","pages":[{"title":"React components","href":"/developers/react-components"},{"title":"Third-party app","href":"/developers/third-party-app"},{"title":"Webhooks","href":"/developers/webhooks"}]},{"group":"AI > Billing","pages":[{"openapi":"get /v1/ai/billing/plans/default","title":"Get default billing plan","href":"/api-reference/endpoints/ai->-billing/get-default-billing-plan"},{"openapi":"get /v1/ai/billing/plans/{id}","title":"Get billing plan","href":"/api-reference/endpoints/ai->-billing/get-billing-plan"},{"openapi":"get /v1/ai/billing/rate-cards/{id}","title":"Get rate card","href":"/api-reference/endpoints/ai->-billing/get-rate-card"},{"openapi":"get /v1/ai/billing/customers/{id}/policies/default","title":"Get default billing policy","href":"/api-reference/endpoints/ai->-billing/get-default-billing-policy"},{"openapi":"get /v1/ai/billing/customers/{id}/policies/agents/{agent_slug}","title":"Get billing policy","href":"/api-reference/endpoints/ai->-billing/get-billing-policy"},{"openapi":"get /v1/ai/billing/customers/{id}/balance","title":"Get billing balance","href":"/api-reference/endpoints/ai->-billing/get-billing-balance"},{"openapi":"get /v1/ai/billing/products/{id}/rate-card","title":"Get product AI rate card","href":"/api-reference/endpoints/ai->-billing/get-product-ai-rate-card"},{"openapi":"get /v1/ai/billing/plans","title":"List billing plans","href":"/api-reference/endpoints/ai->-billing/list-billing-plans"},{"openapi":"get /v1/ai/billing/rate-cards","title":"List rate cards","href":"/api-reference/endpoints/ai->-billing/list-rate-cards"},{"openapi":"get /v1/ai/billing/customers/{id}/policies","title":"List billing policies","href":"/api-reference/endpoints/ai->-billing/list-billing-policies"},{"openapi":"get /v1/ai/billing/customers/{id}/consumption","title":"List consumption","href":"/api-reference/endpoints/ai->-billing/list-consumption"},{"openapi":"post /v1/ai/billing/plans","title":"Create billing plan","href":"/api-reference/endpoints/ai->-billing/create-billing-plan"},{"openapi":"post /v1/ai/billing/rate-cards","title":"Create rate card","href":"/api-reference/endpoints/ai->-billing/create-rate-card"},{"openapi":"post /v1/ai/billing/customers/{id}/apply-default-plan","title":"Apply default billing plan","href":"/api-reference/endpoints/ai->-billing/apply-default-billing-plan"},{"openapi":"delete /v1/ai/billing/plans/default","title":"Clear default billing plan","href":"/api-reference/endpoints/ai->-billing/clear-default-billing-plan"},{"openapi":"delete /v1/ai/billing/products/{id}/rate-card","title":"Clear product AI rate card","href":"/api-reference/endpoints/ai->-billing/clear-product-ai-rate-card"},{"openapi":"put /v1/ai/billing/customers/{id}/policies/agents/{agent_slug}","title":"Configure billing policy","href":"/api-reference/endpoints/ai->-billing/configure-billing-policy"},{"openapi":"put /v1/ai/billing/customers/{id}/policies/default","title":"Configure default billing policy","href":"/api-reference/endpoints/ai->-billing/configure-default-billing-policy"},{"openapi":"delete /v1/ai/billing/customers/{id}/policies/agents/{agent_slug}","title":"Remove billing policy","href":"/api-reference/endpoints/ai->-billing/remove-billing-policy"},{"openapi":"delete /v1/ai/billing/customers/{id}/policies/default","title":"Remove default billing policy","href":"/api-reference/endpoints/ai->-billing/remove-default-billing-policy"},{"openapi":"put /v1/ai/billing/plans/{id}","title":"Replace billing plan","href":"/api-reference/endpoints/ai->-billing/replace-billing-plan"},{"openapi":"put /v1/ai/billing/rate-cards/{id}","title":"Replace rate card","href":"/api-reference/endpoints/ai->-billing/replace-rate-card"},{"openapi":"post /v1/ai/billing/customers/{id}/windows/reset","title":"Reset allowance windows","href":"/api-reference/endpoints/ai->-billing/reset-allowance-windows"},{"openapi":"put /v1/ai/billing/plans/default","title":"Set default billing plan","href":"/api-reference/endpoints/ai->-billing/set-default-billing-plan"},{"openapi":"put /v1/ai/billing/products/{id}/rate-card","title":"Set product AI rate card","href":"/api-reference/endpoints/ai->-billing/set-product-ai-rate-card"},{"openapi":"delete /v1/ai/billing/plans/{id}","title":"Delete billing plan","href":"/api-reference/endpoints/ai->-billing/delete-billing-plan"},{"openapi":"delete /v1/ai/billing/rate-cards/{id}","title":"Delete rate card","href":"/api-reference/endpoints/ai->-billing/delete-rate-card"}]},{"group":"AI > Costs","pages":[{"openapi":"get /v1/ai/billing/costs","title":"List cost catalog","href":"/api-reference/endpoints/ai->-costs/list-cost-catalog"},{"openapi":"post /v1/ai/billing/costs/items","title":"Create custom cost item","href":"/api-reference/endpoints/ai->-costs/create-custom-cost-item"},{"openapi":"delete /v1/ai/billing/costs/items/{id}","title":"Remove custom cost item","href":"/api-reference/endpoints/ai->-costs/remove-custom-cost-item"},{"openapi":"delete /v1/ai/billing/costs/overrides/{id}","title":"Remove provider cost override","href":"/api-reference/endpoints/ai->-costs/remove-provider-cost-override"},{"openapi":"put /v1/ai/billing/costs/items/{id}","title":"Replace custom cost item","href":"/api-reference/endpoints/ai->-costs/replace-custom-cost-item"},{"openapi":"put /v1/ai/billing/costs/overrides","title":"Set provider cost override","href":"/api-reference/endpoints/ai->-costs/set-provider-cost-override"}]},{"group":"AI > Ingest","pages":[{"openapi":"get /v1/ai/billing/snapshot","title":"Get AI billing snapshot","href":"/api-reference/endpoints/ai->-ingest/get-ai-billing-snapshot"},{"openapi":"post /v1/ai/billing/check","title":"Check AI spend allowance","href":"/api-reference/endpoints/ai->-ingest/check-ai-spend-allowance"},{"openapi":"post /v1/ai/billing/consume","title":"Consume AI usage","href":"/api-reference/endpoints/ai->-ingest/consume-ai-usage"},{"openapi":"post /v1/ai/calls","title":"Ingest AI calls","href":"/api-reference/endpoints/ai->-ingest/ingest-ai-calls"}]},{"group":"AI > Monitoring","pages":[{"openapi":"get /v1/agents/monitoring/analyses/{id}","title":"Get monitoring analysis","href":"/api-reference/endpoints/ai->-monitoring/get-monitoring-analysis"},{"openapi":"get /v1/agents/monitoring/analyses","title":"List monitoring analyses","href":"/api-reference/endpoints/ai->-monitoring/list-monitoring-analyses"}]},{"group":"Accounting > Accounts","pages":[{"openapi":"get /v1/accounting/accounts/{id}","title":"Get ledger account","href":"/api-reference/endpoints/accounting->-accounts/get-ledger-account"},{"openapi":"get /v1/accounting/accounts","title":"List ledger accounts","href":"/api-reference/endpoints/accounting->-accounts/list-ledger-accounts"},{"openapi":"get /v1/accounting/primary-ledger/accounts","title":"List primary accounts","href":"/api-reference/endpoints/accounting->-accounts/list-primary-accounts"},{"openapi":"post /v1/accounting/accounts","title":"Create ledger account","href":"/api-reference/endpoints/accounting->-accounts/create-ledger-account"},{"openapi":"put /v1/accounting/accounts/{id}","title":"Update ledger account","href":"/api-reference/endpoints/accounting->-accounts/update-ledger-account"},{"openapi":"delete /v1/accounting/accounts/{id}","title":"Delete ledger account","href":"/api-reference/endpoints/accounting->-accounts/delete-ledger-account"}]},{"group":"Accounting > Journal entries","pages":[{"openapi":"get /v1/accounting/journal-entries/{id}","title":"Get journal entry","href":"/api-reference/endpoints/accounting->-journal-entries/get-journal-entry"},{"openapi":"get /v1/accounting/journal-entries","title":"List journal entries","href":"/api-reference/endpoints/accounting->-journal-entries/list-journal-entries"},{"openapi":"get /v1/accounting/journal-entry-lines","title":"List journal entry lines","href":"/api-reference/endpoints/accounting->-journal-entries/list-journal-entry-lines"},{"openapi":"post /v1/accounting/journal-entries","title":"Create journal entry","href":"/api-reference/endpoints/accounting->-journal-entries/create-journal-entry"},{"openapi":"post /v1/accounting/journal-entries/recognition-preview","title":"Preview recognition schedule","href":"/api-reference/endpoints/accounting->-journal-entries/preview-recognition-schedule"}]},{"group":"Accounting > Ledgers","pages":[{"openapi":"get /v1/accounting/ledgers/{id}","title":"Get ledger","href":"/api-reference/endpoints/accounting->-ledgers/get-ledger"},{"openapi":"get /v1/accounting/ledgers/{id}/close","title":"Get ledger close state","href":"/api-reference/endpoints/accounting->-ledgers/get-ledger-close-state"},{"openapi":"get /v1/accounting/ledgers","title":"List ledgers","href":"/api-reference/endpoints/accounting->-ledgers/list-ledgers"},{"openapi":"get /v1/accounting/ledgers/{id}/close-events","title":"List ledger close events","href":"/api-reference/endpoints/accounting->-ledgers/list-ledger-close-events"},{"openapi":"post /v1/accounting/ledgers","title":"Create ledger","href":"/api-reference/endpoints/accounting->-ledgers/create-ledger"},{"openapi":"put /v1/accounting/ledgers/{id}","title":"Update ledger","href":"/api-reference/endpoints/accounting->-ledgers/update-ledger"},{"openapi":"post /v1/accounting/ledgers/{id}/close","title":"Close ledger period","href":"/api-reference/endpoints/accounting->-ledgers/close-ledger-period"},{"openapi":"post /v1/accounting/ledgers/{id}/reopen","title":"Reopen ledger period","href":"/api-reference/endpoints/accounting->-ledgers/reopen-ledger-period"},{"openapi":"delete /v1/accounting/ledgers/{id}","title":"Delete ledger","href":"/api-reference/endpoints/accounting->-ledgers/delete-ledger"}]},{"group":"Accounting > Reports","pages":[{"openapi":"post /v1/accounting/general-ledger/export","title":"Export general ledger","href":"/api-reference/endpoints/accounting->-reports/export-general-ledger"},{"openapi":"post /v1/accounting/income-statement/export","title":"Export income statement","href":"/api-reference/endpoints/accounting->-reports/export-income-statement"}]},{"group":"Accounting > Revenue recognition","pages":[{"openapi":"get /v1/accounting/revrec/waterfall","title":"Get revenue recognition waterfall","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-revenue-recognition-waterfall"},{"openapi":"get /v1/accounting/revrec/waterfall/cell","title":"Get revenue recognition waterfall cell","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-revenue-recognition-waterfall-cell"},{"openapi":"get /v1/accounting/revrec/unbilled","title":"Get unbilled revenue","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-unbilled-revenue"},{"openapi":"get /v1/accounting/revrec/schedules/{id}","title":"Get revenue recognition schedule","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-revenue-recognition-schedule"},{"openapi":"get /v1/accounting/revrec/slices/{id}","title":"Get revenue recognition slice","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-revenue-recognition-slice"},{"openapi":"get /v1/accounting/revrec/schedules","title":"List revenue recognition schedules","href":"/api-reference/endpoints/accounting->-revenue-recognition/list-revenue-recognition-schedules"},{"openapi":"get /v1/accounting/revrec/schedules/{schedule_id}/adjustments","title":"List revenue recognition adjustments","href":"/api-reference/endpoints/accounting->-revenue-recognition/list-revenue-recognition-adjustments"},{"openapi":"post /v1/accounting/revrec/recognized-summary/export","title":"Export recognized revenue summary","href":"/api-reference/endpoints/accounting->-revenue-recognition/export-recognized-revenue-summary"},{"openapi":"post /v1/accounting/revrec/waterfall/export","title":"Export revenue recognition waterfall","href":"/api-reference/endpoints/accounting->-revenue-recognition/export-revenue-recognition-waterfall"},{"openapi":"post /v1/accounting/revrec/schedules/{schedule_id}/reshape/preview","title":"Preview revenue recognition reshape","href":"/api-reference/endpoints/accounting->-revenue-recognition/preview-revenue-recognition-reshape"},{"openapi":"post /v1/accounting/revrec/schedules/{schedule_id}/reshape","title":"Reshape revenue recognition schedule","description":"Recognize an amount now and optionally spread the remainder over a new window.","href":"/api-reference/endpoints/accounting->-revenue-recognition/reshape-revenue-recognition-schedule"}]},{"group":"Accounting > Rules","pages":[{"openapi":"get /v1/accounting/rules/tree","title":"Get accounting rule tree","href":"/api-reference/endpoints/accounting->-rules/get-accounting-rule-tree"},{"openapi":"post /v1/accounting/rules/defaults","title":"Get rule defaults","description":"Preview default account values and priority for a new accounting rule.","href":"/api-reference/endpoints/accounting->-rules/get-rule-defaults"},{"openapi":"get /v1/accounting/rules/{id}","title":"Get accounting rule","href":"/api-reference/endpoints/accounting->-rules/get-accounting-rule"},{"openapi":"get /v1/accounting/rules","title":"List accounting rules","href":"/api-reference/endpoints/accounting->-rules/list-accounting-rules"},{"openapi":"post /v1/accounting/rules","title":"Create accounting rule","href":"/api-reference/endpoints/accounting->-rules/create-accounting-rule"},{"openapi":"put /v1/accounting/rules/{id}","title":"Update accounting rule","href":"/api-reference/endpoints/accounting->-rules/update-accounting-rule"},{"openapi":"post /v1/accounting/rules/resolve","title":"Resolve accounting rule","href":"/api-reference/endpoints/accounting->-rules/resolve-accounting-rule"},{"openapi":"delete /v1/accounting/rules/{id}","title":"Delete accounting rule","href":"/api-reference/endpoints/accounting->-rules/delete-accounting-rule"}]},{"group":"Aggregators","pages":[{"openapi":"get /v1/aggregators/{id}","title":"Get aggregator","href":"/api-reference/endpoints/aggregators/get-aggregator"},{"openapi":"get /v1/aggregators","title":"List aggregators","href":"/api-reference/endpoints/aggregators/list-aggregators"},{"openapi":"post /v1/aggregators","title":"Create aggregator","href":"/api-reference/endpoints/aggregators/create-aggregator"},{"openapi":"put /v1/aggregators/{id}","title":"Update aggregator","href":"/api-reference/endpoints/aggregators/update-aggregator"},{"openapi":"delete /v1/aggregators/{id}","title":"Delete aggregator","href":"/api-reference/endpoints/aggregators/delete-aggregator"}]},{"group":"Aggregators > Usage","pages":[{"openapi":"get /v1/aggregators/{id}/usage","title":"Get aggregator usage","href":"/api-reference/endpoints/aggregators->-usage/get-aggregator-usage"},{"openapi":"get /v1/aggregators/{id}/usage/timeseries","title":"Get aggregator usage timeseries","href":"/api-reference/endpoints/aggregators->-usage/get-aggregator-usage-timeseries"},{"openapi":"get /v1/aggregators/{id}/usage/group-by-customer","title":"Get aggregator usage grouped by customer","href":"/api-reference/endpoints/aggregators->-usage/get-aggregator-usage-grouped-by-customer"},{"openapi":"get /v1/aggregators/{id}/usage/events","title":"Get aggregator usage events","href":"/api-reference/endpoints/aggregators->-usage/get-aggregator-usage-events"}]},{"group":"Analytics","pages":[{"openapi":"get /v1/analytics","title":"Get analytics","href":"/api-reference/endpoints/analytics/get-analytics"}]},{"group":"Approval workflows","pages":[{"openapi":"get /v1/approvals/workflows/{id}","title":"Get approval workflow","href":"/api-reference/endpoints/approval-workflows/get-approval-workflow"},{"openapi":"get /v1/approvals/workflows","title":"List approval workflows","href":"/api-reference/endpoints/approval-workflows/list-approval-workflows"},{"openapi":"post /v1/approvals/workflows","title":"Create approval workflow","href":"/api-reference/endpoints/approval-workflows/create-approval-workflow"},{"openapi":"put /v1/approvals/workflows/{id}","title":"Update approval workflow","href":"/api-reference/endpoints/approval-workflows/update-approval-workflow"},{"openapi":"delete /v1/approvals/workflows/{id}","title":"Delete approval workflow","href":"/api-reference/endpoints/approval-workflows/delete-approval-workflow"}]},{"group":"Audit logs","pages":[{"openapi":"get /v1/audit-logs","title":"List audit logs","href":"/api-reference/endpoints/audit-logs/list-audit-logs"}]},{"group":"Bank Accounts","pages":[{"openapi":"get /v1/bank-accounts/{id}","title":"Get bank account","href":"/api-reference/endpoints/bank-accounts/get-bank-account"},{"openapi":"get /v1/bank-accounts","title":"List bank accounts","href":"/api-reference/endpoints/bank-accounts/list-bank-accounts"},{"openapi":"get /v1/bank-accounts/{id}/transactions","title":"List bank transactions","href":"/api-reference/endpoints/bank-accounts/list-bank-transactions"}]},{"group":"Billable events","pages":[{"openapi":"get /v1/events","title":"Get events","href":"/api-reference/endpoints/billable-events/get-events"},{"openapi":"post /v1/events","title":"Ingest billable event","href":"/api-reference/endpoints/billable-events/ingest-billable-event"},{"openapi":"post /v1/events/batch","title":"Ingest billable events","href":"/api-reference/endpoints/billable-events/ingest-billable-events"},{"openapi":"delete /v1/events","title":"Delete billable events","href":"/api-reference/endpoints/billable-events/delete-billable-events"}]},{"group":"Catalog","pages":[{"openapi":"get /v1/catalog/versions/draft","title":"Get catalog draft","href":"/api-reference/endpoints/catalog/get-catalog-draft"},{"openapi":"get /v1/catalog/versions/{id}","title":"Get catalog version","href":"/api-reference/endpoints/catalog/get-catalog-version"},{"openapi":"get /v1/catalog/versions","title":"List catalog versions","href":"/api-reference/endpoints/catalog/list-catalog-versions"},{"openapi":"post /v1/catalog/versions/draft","title":"Create catalog draft","href":"/api-reference/endpoints/catalog/create-catalog-draft"},{"openapi":"delete /v1/catalog/versions/draft","title":"Discard catalog draft","href":"/api-reference/endpoints/catalog/discard-catalog-draft"},{"openapi":"get /v1/catalog/export","title":"Export catalog","href":"/api-reference/endpoints/catalog/export-catalog"},{"openapi":"post /v1/catalog/versions/draft/publish","title":"Publish catalog draft","href":"/api-reference/endpoints/catalog/publish-catalog-draft"},{"openapi":"post /v1/catalog/versions/{id}/revert","title":"Revert catalog version","href":"/api-reference/endpoints/catalog/revert-catalog-version"}]},{"group":"Companies","pages":[{"openapi":"get /v1/companies","title":"List companies","href":"/api-reference/endpoints/companies/list-companies"},{"openapi":"post /v1/companies","title":"Create company","href":"/api-reference/endpoints/companies/create-company"}]},{"group":"Contracts > Clauses","pages":[{"openapi":"get /v1/contracts/clauses/{id}","title":"Get contract clause","href":"/api-reference/endpoints/contracts->-clauses/get-contract-clause"},{"openapi":"get /v1/contracts/clauses","title":"List contract clauses","href":"/api-reference/endpoints/contracts->-clauses/list-contract-clauses"},{"openapi":"post /v1/contracts/clauses","title":"Create contract clause","href":"/api-reference/endpoints/contracts->-clauses/create-contract-clause"},{"openapi":"put /v1/contracts/clauses/{id}","title":"Update contract clause","href":"/api-reference/endpoints/contracts->-clauses/update-contract-clause"},{"openapi":"delete /v1/contracts/clauses/{id}","title":"Delete contract clause","href":"/api-reference/endpoints/contracts->-clauses/delete-contract-clause"}]},{"group":"Contracts > Documents","pages":[{"openapi":"get /v1/contracts/documents/{id}","title":"Get contract document","href":"/api-reference/endpoints/contracts->-documents/get-contract-document"},{"openapi":"get /v1/contracts/documents","title":"List contract documents","href":"/api-reference/endpoints/contracts->-documents/list-contract-documents"},{"openapi":"post /v1/contracts/documents","title":"Create contract document","href":"/api-reference/endpoints/contracts->-documents/create-contract-document"},{"openapi":"post /v1/contracts/documents/{id}/contents","title":"Create contract document content","href":"/api-reference/endpoints/contracts->-documents/create-contract-document-content"},{"openapi":"put /v1/contracts/documents/{id}","title":"Update contract document","href":"/api-reference/endpoints/contracts->-documents/update-contract-document"},{"openapi":"put /v1/contracts/documents/{id}/contents/{contentId}","title":"Update contract document content","href":"/api-reference/endpoints/contracts->-documents/update-contract-document-content"},{"openapi":"delete /v1/contracts/documents/{id}","title":"Delete contract document","href":"/api-reference/endpoints/contracts->-documents/delete-contract-document"},{"openapi":"delete /v1/contracts/documents/{id}/contents/{contentId}","title":"Delete contract document content","href":"/api-reference/endpoints/contracts->-documents/delete-contract-document-content"}]},{"group":"Coupons","pages":[{"openapi":"get /v1/coupons/{id}","title":"Get coupon","href":"/api-reference/endpoints/coupons/get-coupon"},{"openapi":"get /v1/coupons","title":"List coupons","href":"/api-reference/endpoints/coupons/list-coupons"},{"openapi":"post /v1/coupons","title":"Create coupon","href":"/api-reference/endpoints/coupons/create-coupon"},{"openapi":"put /v1/coupons/{id}","title":"Update coupon","href":"/api-reference/endpoints/coupons/update-coupon"},{"openapi":"delete /v1/coupons/{id}","title":"Delete coupon","href":"/api-reference/endpoints/coupons/delete-coupon"}]},{"group":"Coupons > Promotion codes","pages":[{"openapi":"get /v1/promotion-codes/{id}","title":"Get promotion code","href":"/api-reference/endpoints/coupons->-promotion-codes/get-promotion-code"},{"openapi":"get /v1/promotion-codes","title":"List promotion codes","href":"/api-reference/endpoints/coupons->-promotion-codes/list-promotion-codes"},{"openapi":"post /v1/promotion-codes","title":"Create promotion code","href":"/api-reference/endpoints/coupons->-promotion-codes/create-promotion-code"},{"openapi":"patch /v1/promotion-codes/{id}","title":"Update promotion code","href":"/api-reference/endpoints/coupons->-promotion-codes/update-promotion-code"},{"openapi":"delete /v1/promotion-codes/{id}","title":"Delete promotion code","href":"/api-reference/endpoints/coupons->-promotion-codes/delete-promotion-code"}]},{"group":"Custom properties","pages":[{"openapi":"get /v1/custom-properties","title":"List custom properties","href":"/api-reference/endpoints/custom-properties/list-custom-properties"},{"openapi":"post /v1/custom-properties","title":"Create custom property","href":"/api-reference/endpoints/custom-properties/create-custom-property"},{"openapi":"put /v1/custom-properties/{id}","title":"Update custom property","href":"/api-reference/endpoints/custom-properties/update-custom-property"},{"openapi":"delete /v1/custom-properties/{id}","title":"Delete custom property","href":"/api-reference/endpoints/custom-properties/delete-custom-property"}]},{"group":"Customers","pages":[{"openapi":"get /v2/customers/{id}","title":"Get customer","href":"/api-reference/endpoints/customers/get-customer"},{"openapi":"get /v1/customers/{id}/portal","title":"Get customer portal","href":"/api-reference/endpoints/customers/get-customer-portal"},{"openapi":"get /v1/customers/{id}/taxes/rates","title":"Get customer tax rates","href":"/api-reference/endpoints/customers/get-customer-tax-rates"},{"openapi":"get /v1/customers/{id}/arr-history","title":"Get customer ARR history","href":"/api-reference/endpoints/customers/get-customer-arr-history"},{"openapi":"get /v1/customers/{id}/valuation","title":"Get customer valuation","href":"/api-reference/endpoints/customers/get-customer-valuation"},{"openapi":"get /v2/customers","title":"List customers","href":"/api-reference/endpoints/customers/list-customers"},{"openapi":"post /v1/customers","title":"Create customer","href":"/api-reference/endpoints/customers/create-customer"},{"openapi":"post /v1/customers/batch","title":"Create customers batch","href":"/api-reference/endpoints/customers/create-customers-batch"},{"openapi":"put /v1/customers/{id}","title":"Update customer","href":"/api-reference/endpoints/customers/update-customer"},{"openapi":"put /v1/customers/{id}/archive","title":"Archive customer","href":"/api-reference/endpoints/customers/archive-customer"},{"openapi":"post /v1/customers/providers-bulk-update","title":"Bulk update providers/customers mapping","href":"/api-reference/endpoints/customers/bulk-update-providerscustomers-mapping"},{"openapi":"put /v1/customers/{id}/unarchive","title":"Unarchive customer","href":"/api-reference/endpoints/customers/unarchive-customer"},{"openapi":"delete /v1/customers/{id}","title":"Delete customer","href":"/api-reference/endpoints/customers/delete-customer"}]},{"group":"Customers > Address","pages":[{"openapi":"get /v1/customers/{customerId}/addresses","title":"List addresses","href":"/api-reference/endpoints/customers->-address/list-addresses"},{"openapi":"post /v1/customers/{customerId}/addresses","title":"Create address","href":"/api-reference/endpoints/customers->-address/create-address"},{"openapi":"patch /v1/customers/{customerId}/addresses/{addressId}","title":"Update address","href":"/api-reference/endpoints/customers->-address/update-address"},{"openapi":"delete /v1/customers/{customerId}/addresses/{addressId}","title":"Delete address","href":"/api-reference/endpoints/customers->-address/delete-address"}]},{"group":"Customers > Credits","pages":[{"openapi":"get /v1/customers/{id}/credits/{productId}","title":"Get credit product","href":"/api-reference/endpoints/customers->-credits/get-credit-product"},{"openapi":"get /v1/customers/{id}/credits/{productId}/portal-settings","title":"Get credit portal settings","href":"/api-reference/endpoints/customers->-credits/get-credit-portal-settings"},{"openapi":"get /v1/customers/credits","title":"List all credit products","href":"/api-reference/endpoints/customers->-credits/list-all-credit-products"},{"openapi":"get /v1/customers/{id}/credits","title":"List credit products","href":"/api-reference/endpoints/customers->-credits/list-credit-products"},{"openapi":"get /v1/customers/{id}/credits/{productId}/transactions","title":"List credit transactions","href":"/api-reference/endpoints/customers->-credits/list-credit-transactions"},{"openapi":"post /v1/customers/{id}/credits","title":"Create credit product","href":"/api-reference/endpoints/customers->-credits/create-credit-product"},{"openapi":"post /v1/customers/{id}/credits/{productId}/usage","title":"Create credits usage","href":"/api-reference/endpoints/customers->-credits/create-credits-usage"},{"openapi":"put /v1/customers/{id}/credits/{productId}","title":"Update credit product","href":"/api-reference/endpoints/customers->-credits/update-credit-product"},{"openapi":"patch /v1/customers/{id}/credits/{productId}/transactions/{transactionId}","title":"Update credit topup expiration","href":"/api-reference/endpoints/customers->-credits/update-credit-topup-expiration"},{"openapi":"put /v1/customers/{id}/credits/{productId}/portal-settings","title":"Update credit portal settings","href":"/api-reference/endpoints/customers->-credits/update-credit-portal-settings"},{"openapi":"post /v1/customers/{id}/credits/{productId}/purchase","title":"Purchase credits","href":"/api-reference/endpoints/customers->-credits/purchase-credits"},{"openapi":"post /v1/customers/{id}/credits/{productId}/topup","title":"Topup credits","href":"/api-reference/endpoints/customers->-credits/topup-credits"}]},{"group":"Customers > Features","pages":[{"openapi":"get /v1/customers/{id}/features","title":"Resolve customer features","href":"/api-reference/endpoints/customers->-features/resolve-customer-features"},{"openapi":"put /v1/customers/{id}/features/{code}","title":"Set customer feature","href":"/api-reference/endpoints/customers->-features/set-customer-feature"},{"openapi":"delete /v1/customers/{id}/features/{code}","title":"Delete customer feature","href":"/api-reference/endpoints/customers->-features/delete-customer-feature"}]},{"group":"Customers > Payment methods","pages":[{"openapi":"get /v1/customers/{id}/payment-methods/{paymentMethodId}","title":"Get payment method","href":"/api-reference/endpoints/customers->-payment-methods/get-payment-method"},{"openapi":"get /v1/customers/{id}/payment-methods","title":"List payment methods","href":"/api-reference/endpoints/customers->-payment-methods/list-payment-methods"},{"openapi":"post /v1/customers/{id}/payment-methods","title":"Create payment method","href":"/api-reference/endpoints/customers->-payment-methods/create-payment-method"},{"openapi":"delete /v1/customers/{id}/payment-methods/{paymentMethodId}","title":"Delete payment method","href":"/api-reference/endpoints/customers->-payment-methods/delete-payment-method"}]},{"group":"Customers > Segments","pages":[{"openapi":"get /v1/customers/segments/{id}","title":"Get segment","href":"/api-reference/endpoints/customers->-segments/get-segment"},{"openapi":"get /v1/customers/segments","title":"List segments","href":"/api-reference/endpoints/customers->-segments/list-segments"},{"openapi":"post /v1/customers/segments","title":"Create segment","href":"/api-reference/endpoints/customers->-segments/create-segment"},{"openapi":"patch /v1/customers/segments/{id}","title":"Update segment","href":"/api-reference/endpoints/customers->-segments/update-segment"},{"openapi":"delete /v1/customers/segments/{id}","title":"Delete segment","href":"/api-reference/endpoints/customers->-segments/delete-segment"}]},{"group":"Customers > Shipping","pages":[{"openapi":"get /v1/customers/{customerId}/shipping","title":"Get shipping destination","href":"/api-reference/endpoints/customers->-shipping/get-shipping-destination"},{"openapi":"put /v1/customers/{customerId}/shipping","title":"Set shipping destination","href":"/api-reference/endpoints/customers->-shipping/set-shipping-destination"}]},{"group":"Customers > Usage","pages":[{"openapi":"get /v1/customers/{id}/usage/{aggregator_id}","title":"Get customer usage for an aggregator","href":"/api-reference/endpoints/customers->-usage/get-customer-usage-for-an-aggregator"},{"openapi":"get /v1/customers/{id}/usage/{aggregator_id}/timeseries","title":"Get customer usage timeseries","href":"/api-reference/endpoints/customers->-usage/get-customer-usage-timeseries"},{"openapi":"get /v1/customers/{id}/usage/{aggregator_id}/events","title":"Get customer usage events","href":"/api-reference/endpoints/customers->-usage/get-customer-usage-events"},{"openapi":"get /v1/customers/{id}/usage","title":"List customer usage","href":"/api-reference/endpoints/customers->-usage/list-customer-usage"}]},{"group":"Exports","pages":[{"openapi":"get /v1/exports/{exportId}","title":"Get export","href":"/api-reference/endpoints/exports/get-export"},{"openapi":"get /v1/exports","title":"List exports","href":"/api-reference/endpoints/exports/list-exports"},{"openapi":"get /v2/exports/{exportId}/download","title":"Download export","href":"/api-reference/endpoints/exports/download-export"},{"openapi":"post /v1/exports","title":"Create export","href":"/api-reference/endpoints/exports/create-export"}]},{"group":"Features","pages":[{"openapi":"get /v1/features/{code}","title":"Get feature","href":"/api-reference/endpoints/features/get-feature"},{"openapi":"get /v1/features","title":"List features","href":"/api-reference/endpoints/features/list-features"},{"openapi":"post /v1/features","title":"Create feature","href":"/api-reference/endpoints/features/create-feature"},{"openapi":"put /v1/features/{code}","title":"Update feature","href":"/api-reference/endpoints/features/update-feature"},{"openapi":"put /v1/features/{code}/archive","title":"Archive feature","href":"/api-reference/endpoints/features/archive-feature"},{"openapi":"put /v1/features/{code}/unarchive","title":"Unarchive feature","href":"/api-reference/endpoints/features/unarchive-feature"},{"openapi":"delete /v1/features/{code}","title":"Delete feature","href":"/api-reference/endpoints/features/delete-feature"}]},{"group":"Files","pages":[{"openapi":"get /v1/files","title":"List files","href":"/api-reference/endpoints/files/list-files"},{"openapi":"get /v1/files/{id}/download","title":"Download file","href":"/api-reference/endpoints/files/download-file"},{"openapi":"post /v1/files","title":"Create file","href":"/api-reference/endpoints/files/create-file"},{"openapi":"delete /v1/files/{id}","title":"Delete file","href":"/api-reference/endpoints/files/delete-file"}]},{"group":"Integrations","pages":[{"openapi":"post /v1/integrations/components/token","title":"Create component token","href":"/api-reference/endpoints/integrations/create-component-token"}]},{"group":"Invoices","pages":[{"openapi":"get /v1/invoices/{id}","deprecated":true,"title":"Get invoice","href":"/api-reference/endpoints/invoices/get-invoice"},{"openapi":"get /v2/invoices/{id}","title":"Get invoice","href":"/api-reference/endpoints/invoices/get-invoice-1"},{"openapi":"get /v1/invoices","deprecated":true,"title":"List invoices","href":"/api-reference/endpoints/invoices/list-invoices"},{"openapi":"get /v2/invoices","title":"List invoices","href":"/api-reference/endpoints/invoices/list-invoices-1"},{"openapi":"get /v2/invoices/{id}/download","title":"Download invoice","href":"/api-reference/endpoints/invoices/download-invoice"},{"openapi":"post /v1/invoices","title":"Create invoice","href":"/api-reference/endpoints/invoices/create-invoice"},{"openapi":"post /v1/invoices/{id}/credit-notes","title":"Create credit note","href":"/api-reference/endpoints/invoices/create-credit-note"},{"openapi":"post /v2/invoices/batch","title":"Create invoices","href":"/api-reference/endpoints/invoices/create-invoices"},{"openapi":"patch /v1/invoices/{id}","title":"Update invoice","href":"/api-reference/endpoints/invoices/update-invoice"},{"openapi":"post /v1/invoices/{id}/charge","title":"Charge invoice","href":"/api-reference/endpoints/invoices/charge-invoice"},{"openapi":"post /v1/invoices/{id}/uncollectible","title":"Mark as uncollectible","href":"/api-reference/endpoints/invoices/mark-as-uncollectible"},{"openapi":"post /v1/invoices/send-email","title":"Send invoice emails","href":"/api-reference/endpoints/invoices/send-invoice-emails"},{"openapi":"post /v1/invoices/{id}/upload","title":"Upload PDF to invoice","href":"/api-reference/endpoints/invoices/upload-pdf-to-invoice"},{"openapi":"post /v1/invoices/{id}/validate","title":"Validate draft invoice","href":"/api-reference/endpoints/invoices/validate-draft-invoice"},{"openapi":"post /v1/invoices/{id}/void","title":"Void invoice","href":"/api-reference/endpoints/invoices/void-invoice"},{"openapi":"delete /v1/invoices/{id}","title":"Delete invoice","href":"/api-reference/endpoints/invoices/delete-invoice"}]},{"group":"Invoices > Events","pages":[{"openapi":"get /v1/invoices/{id}/events","title":"List invoice events","href":"/api-reference/endpoints/invoices->-events/list-invoice-events"}]},{"group":"Invoices > Transactions","pages":[{"openapi":"post /v1/invoices/{id}/transactions","title":"Create transaction","href":"/api-reference/endpoints/invoices->-transactions/create-transaction"},{"openapi":"delete /v1/invoices/{id}/transactions/{transactionId}","title":"Delete transaction","href":"/api-reference/endpoints/invoices->-transactions/delete-transaction"}]},{"group":"Invoicing entities","pages":[{"openapi":"get /v1/invoicing-entities/{id}","title":"Get invoicing entity","href":"/api-reference/endpoints/invoicing-entities/get-invoicing-entity"},{"openapi":"get /v1/invoicing-entities","title":"List invoicing entities","href":"/api-reference/endpoints/invoicing-entities/list-invoicing-entities"},{"openapi":"post /v1/invoicing-entities","title":"Create invoicing entity","href":"/api-reference/endpoints/invoicing-entities/create-invoicing-entity"},{"openapi":"put /v1/invoicing-entities/{id}","title":"Update invoicing entity","href":"/api-reference/endpoints/invoicing-entities/update-invoicing-entity"},{"openapi":"delete /v1/invoicing-entities/{id}","title":"Delete invoicing entity","href":"/api-reference/endpoints/invoicing-entities/delete-invoicing-entity"}]},{"group":"OAuth2","pages":[{"openapi":"get /oauth/userinfo","title":"Get user info","href":"/api-reference/endpoints/oauth2/get-user-info"},{"openapi":"get /oauth/authorize","title":"Authorize","href":"/api-reference/endpoints/oauth2/authorize"},{"openapi":"post /oauth/tokens","title":"Generate tokens","href":"/api-reference/endpoints/oauth2/generate-tokens"},{"openapi":"get /oauth/callback","title":"OAuth callback","href":"/api-reference/endpoints/oauth2/oauth-callback"},{"openapi":"post /oauth/register","title":"Register OAuth client","href":"/api-reference/endpoints/oauth2/register-oauth-client"},{"openapi":"post /oauth/revoke","title":"Revoke token","href":"/api-reference/endpoints/oauth2/revoke-token"}]},{"group":"Organisations","pages":[{"openapi":"get /v1/organisations/{id}","title":"Get organisation","href":"/api-reference/endpoints/organisations/get-organisation"},{"openapi":"get /v1/organisations","title":"List organisations","href":"/api-reference/endpoints/organisations/list-organisations"},{"openapi":"patch /v1/organisations/{id}","title":"Patch organisation","href":"/api-reference/endpoints/organisations/patch-organisation"}]},{"group":"Payments","pages":[{"openapi":"post /v1/payments","title":"Create payment","href":"/api-reference/endpoints/payments/create-payment"}]},{"group":"Price books","pages":[{"openapi":"get /v1/price-books/{id}","title":"Get price book","href":"/api-reference/endpoints/price-books/get-price-book"},{"openapi":"get /v1/price-books","title":"List price books","href":"/api-reference/endpoints/price-books/list-price-books"},{"openapi":"post /v1/price-books","title":"Create price book","href":"/api-reference/endpoints/price-books/create-price-book"},{"openapi":"put /v1/price-books/{id}","title":"Update price book","href":"/api-reference/endpoints/price-books/update-price-book"},{"openapi":"post /v1/price-books/{id}/products","title":"Add products to price book","href":"/api-reference/endpoints/price-books/add-products-to-price-book"},{"openapi":"delete /v1/price-books/{id}/products/{productId}","title":"Remove product from price book","href":"/api-reference/endpoints/price-books/remove-product-from-price-book"},{"openapi":"delete /v1/price-books/{id}","title":"Delete price book","href":"/api-reference/endpoints/price-books/delete-price-book"}]},{"group":"Price configurations","pages":[{"openapi":"get /v1/price-configurations/{id}","title":"Get price configuration","href":"/api-reference/endpoints/price-configurations/get-price-configuration"},{"openapi":"get /v1/price-configurations","title":"List price configurations","href":"/api-reference/endpoints/price-configurations/list-price-configurations"},{"openapi":"post /v1/price-configurations","title":"Create price configuration","href":"/api-reference/endpoints/price-configurations/create-price-configuration"},{"openapi":"put /v1/price-configurations/{id}/prices","title":"Update prices","href":"/api-reference/endpoints/price-configurations/update-prices"},{"openapi":"delete /v1/price-configurations/{id}","title":"Delete price configuration","href":"/api-reference/endpoints/price-configurations/delete-price-configuration"}]},{"group":"Products","pages":[{"openapi":"get /v1/products/{id}","title":"Get product","href":"/api-reference/endpoints/products/get-product"},{"openapi":"get /v1/products","title":"List products","href":"/api-reference/endpoints/products/list-products"},{"openapi":"post /v1/products","title":"Create product","href":"/api-reference/endpoints/products/create-product"},{"openapi":"put /v1/products/{id}","title":"Update product","href":"/api-reference/endpoints/products/update-product"},{"openapi":"put /v1/products/{id}/archive","title":"Archive product","href":"/api-reference/endpoints/products/archive-product"},{"openapi":"put /v1/products/{id}/unarchive","title":"Unarchive product","href":"/api-reference/endpoints/products/unarchive-product"},{"openapi":"delete /v1/products/{id}","title":"Delete product","href":"/api-reference/endpoints/products/delete-product"}]},{"group":"Products > Features","pages":[{"openapi":"get /v1/products/{id}/features","title":"List product features","href":"/api-reference/endpoints/products->-features/list-product-features"},{"openapi":"put /v1/products/{id}/features/{code}","title":"Set product feature","href":"/api-reference/endpoints/products->-features/set-product-feature"},{"openapi":"delete /v1/products/{id}/features/{code}","title":"Delete product feature","href":"/api-reference/endpoints/products->-features/delete-product-feature"}]},{"group":"Quotes","pages":[{"openapi":"get /v1/quotes/{id}","title":"Get quote","href":"/api-reference/endpoints/quotes/get-quote"},{"openapi":"get /v1/quotes/{id}/valuation","title":"Get quote valuation","href":"/api-reference/endpoints/quotes/get-quote-valuation"},{"openapi":"get /v1/quotes","title":"List quotes","href":"/api-reference/endpoints/quotes/list-quotes"},{"openapi":"get /v1/quotes/{id}/signers","title":"List quote signers","href":"/api-reference/endpoints/quotes/list-quote-signers"},{"openapi":"get /v1/quotes/{id}/download","title":"Download quote","href":"/api-reference/endpoints/quotes/download-quote"},{"openapi":"get /v1/quotes/{quoteId}/files/{id}/download","title":"Download quote file","href":"/api-reference/endpoints/quotes/download-quote-file"},{"openapi":"post /v1/quotes","title":"Create quote","href":"/api-reference/endpoints/quotes/create-quote"},{"openapi":"patch /v1/quotes/{id}","title":"Update quote","href":"/api-reference/endpoints/quotes/update-quote"},{"openapi":"post /v1/quotes/{id}/duplicate","title":"Duplicate quote","href":"/api-reference/endpoints/quotes/duplicate-quote"},{"openapi":"post /v1/quotes/{id}/finalize","title":"Finalize quote","href":"/api-reference/endpoints/quotes/finalize-quote"},{"openapi":"post /v1/quotes/{id}/redraft","title":"Redraft quote","href":"/api-reference/endpoints/quotes/redraft-quote"},{"openapi":"post /v1/quotes/{id}/send","title":"Send quote","href":"/api-reference/endpoints/quotes/send-quote"},{"openapi":"put /v1/quotes/{id}/signers","title":"Set quote signers","href":"/api-reference/endpoints/quotes/set-quote-signers"},{"openapi":"post /v1/quotes/{id}/sign","title":"Sign quote","href":"/api-reference/endpoints/quotes/sign-quote"},{"openapi":"post /v1/quotes/{id}/void","title":"Void quote","href":"/api-reference/endpoints/quotes/void-quote"}]},{"group":"Quotes > Approvals","pages":[{"openapi":"get /v1/quotes/{id}/approvals","title":"Get quote approvals","href":"/api-reference/endpoints/quotes->-approvals/get-quote-approvals"},{"openapi":"post /v1/quotes/{id}/approve","title":"Approve quote","href":"/api-reference/endpoints/quotes->-approvals/approve-quote"}]},{"group":"Quotes > Templates","pages":[{"openapi":"get /v1/quotes/templates/{id}","title":"Get quote template","href":"/api-reference/endpoints/quotes->-templates/get-quote-template"},{"openapi":"get /v1/quotes/templates","title":"List quote templates","href":"/api-reference/endpoints/quotes->-templates/list-quote-templates"}]},{"group":"Subscriptions","pages":[{"openapi":"get /v2/subscriptions/{id}","title":"Get subscription","href":"/api-reference/endpoints/subscriptions/get-subscription"},{"openapi":"get /v1/subscriptions/{id}/arr-history","title":"Get subscription ARR history","href":"/api-reference/endpoints/subscriptions/get-subscription-arr-history"},{"openapi":"get /v1/subscriptions/{id}/valuation","title":"Get subscription valuation","href":"/api-reference/endpoints/subscriptions/get-subscription-valuation"},{"openapi":"get /v1/subscriptions/{id}/estimates","title":"List subscription estimates","href":"/api-reference/endpoints/subscriptions/list-subscription-estimates"},{"openapi":"get /v2/subscriptions","title":"List subscriptions","href":"/api-reference/endpoints/subscriptions/list-subscriptions"},{"openapi":"post /v1/subscriptions/{id}/update","title":"Create subscription update","href":"/api-reference/endpoints/subscriptions/create-subscription-update"},{"openapi":"post /v1/subscriptions/{id}/update-many","title":"Create subscription updates","href":"/api-reference/endpoints/subscriptions/create-subscription-updates"},{"openapi":"post /v2/subscriptions","title":"Create subscription","href":"/api-reference/endpoints/subscriptions/create-subscription"},{"openapi":"put /v2/subscriptions/{id}","title":"Update subscription","href":"/api-reference/endpoints/subscriptions/update-subscription"},{"openapi":"post /v1/subscriptions/{id}/activate","title":"Activate subscription","href":"/api-reference/endpoints/subscriptions/activate-subscription"},{"openapi":"post /v1/subscriptions/{id}/cancel","title":"Cancel subscription","href":"/api-reference/endpoints/subscriptions/cancel-subscription"},{"openapi":"post /v1/subscriptions/{id}/pause","title":"Pause subscription","href":"/api-reference/endpoints/subscriptions/pause-subscription"},{"openapi":"get /v1/subscriptions/{id}/preview-timeline","title":"Preview subscription timeline","href":"/api-reference/endpoints/subscriptions/preview-subscription-timeline"},{"openapi":"post /v1/subscriptions/{id}/reactivate","title":"Reactivate subscription","href":"/api-reference/endpoints/subscriptions/reactivate-subscription"},{"openapi":"post /v2/subscriptions/{id}/refresh-seat-products","title":"Refresh seat products","href":"/api-reference/endpoints/subscriptions/refresh-seat-products"},{"openapi":"post /v1/subscriptions/refresh","title":"Refresh subscriptions","href":"/api-reference/endpoints/subscriptions/refresh-subscriptions"},{"openapi":"post /v1/subscriptions/{id}/reinstate","title":"Reinstate subscription","href":"/api-reference/endpoints/subscriptions/reinstate-subscription"},{"openapi":"post /v1/subscriptions/{id}/renew","title":"Renew subscription","href":"/api-reference/endpoints/subscriptions/renew-subscription"},{"openapi":"post /v1/subscriptions/{id}/simulate-updates","title":"Simulate subscription updates","href":"/api-reference/endpoints/subscriptions/simulate-subscription-updates"}]},{"group":"Subscriptions > Phases","pages":[{"openapi":"get /v2/subscriptions/{id}/phases/{phaseId}","title":"Get subscription phase","href":"/api-reference/endpoints/subscriptions->-phases/get-subscription-phase"},{"openapi":"get /v2/subscriptions/{id}/phases","title":"List subscription phases","href":"/api-reference/endpoints/subscriptions->-phases/list-subscription-phases"},{"openapi":"post /v2/subscriptions/{id}/next-phase","title":"Transition subscription to next phase","href":"/api-reference/endpoints/subscriptions->-phases/transition-subscription-to-next-phase"}]},{"group":"Subscriptions > Templates","pages":[{"openapi":"get /v1/subscriptions/templates/{id}","title":"Get subscription template","href":"/api-reference/endpoints/subscriptions->-templates/get-subscription-template"},{"openapi":"get /v1/subscriptions/templates","title":"List subscription templates","href":"/api-reference/endpoints/subscriptions->-templates/list-subscription-templates"},{"openapi":"post /v1/subscriptions/templates","title":"Create subscription template","href":"/api-reference/endpoints/subscriptions->-templates/create-subscription-template"},{"openapi":"post /v1/subscriptions/templates/{id}/configurations","title":"Create subscription template configuration","href":"/api-reference/endpoints/subscriptions->-templates/create-subscription-template-configuration"},{"openapi":"patch /v1/subscriptions/templates/{id}","title":"Update subscription template","href":"/api-reference/endpoints/subscriptions->-templates/update-subscription-template"},{"openapi":"put /v1/subscriptions/templates/{templateId}/configurations/{id}","title":"Update subscription template configuration","href":"/api-reference/endpoints/subscriptions->-templates/update-subscription-template-configuration"},{"openapi":"delete /v1/subscriptions/templates/{id}","title":"Delete subscription template","href":"/api-reference/endpoints/subscriptions->-templates/delete-subscription-template"},{"openapi":"delete /v1/subscriptions/templates/{templateId}/configurations/{id}","title":"Delete subscription template configuration","href":"/api-reference/endpoints/subscriptions->-templates/delete-subscription-template-configuration"}]},{"group":"Subscriptions > Transitions","pages":[{"openapi":"get /v2/subscriptions/transitions/{id}","title":"Get subscription transition","href":"/api-reference/endpoints/subscriptions->-transitions/get-subscription-transition"},{"openapi":"get /v2/subscriptions/transitions","title":"List subscription transitions","href":"/api-reference/endpoints/subscriptions->-transitions/list-subscription-transitions"},{"openapi":"post /v2/subscriptions/transitions","title":"Create subscription transition","href":"/api-reference/endpoints/subscriptions->-transitions/create-subscription-transition"},{"openapi":"post /v2/subscriptions/transitions/{id}/cancel","title":"Cancel subscription transition","href":"/api-reference/endpoints/subscriptions->-transitions/cancel-subscription-transition"},{"openapi":"post /v2/subscriptions/transitions/preview","title":"Preview subscription transition","href":"/api-reference/endpoints/subscriptions->-transitions/preview-subscription-transition"}]},{"group":"Taxes","pages":[{"openapi":"get /v1/taxes/rates/{id}","title":"Get tax rate","href":"/api-reference/endpoints/taxes/get-tax-rate"},{"openapi":"get /v1/taxes/rates","title":"List tax rates","href":"/api-reference/endpoints/taxes/list-tax-rates"},{"openapi":"post /v1/taxes/rates","title":"Create tax rate","href":"/api-reference/endpoints/taxes/create-tax-rate"},{"openapi":"patch /v1/taxes/rates/{id}","title":"Update tax rate","href":"/api-reference/endpoints/taxes/update-tax-rate"},{"openapi":"delete /v1/taxes/rates/{id}","title":"Delete tax rate","href":"/api-reference/endpoints/taxes/delete-tax-rate"}]},{"group":"Third-party apps","pages":[{"openapi":"get /v1/apps","title":"List apps","href":"/api-reference/endpoints/third-party-apps/list-apps"},{"openapi":"post /v1/apps","title":"Create app","href":"/api-reference/endpoints/third-party-apps/create-app"},{"openapi":"put /v1/apps/{id}","title":"Update app","href":"/api-reference/endpoints/third-party-apps/update-app"},{"openapi":"delete /v1/apps/{id}","title":"Delete app","href":"/api-reference/endpoints/third-party-apps/delete-app"}]},{"group":"Transactions","pages":[{"openapi":"get /v1/transactions/{id}","title":"Get transaction","href":"/api-reference/endpoints/transactions/get-transaction"},{"openapi":"get /v1/transactions","title":"List transactions","href":"/api-reference/endpoints/transactions/list-transactions"},{"openapi":"post /v1/transactions","title":"Create transaction","href":"/api-reference/endpoints/transactions/create-transaction"},{"openapi":"post /v1/transactions/{id}/refund","title":"Refund transaction","href":"/api-reference/endpoints/transactions/refund-transaction"},{"openapi":"delete /v1/transactions/{id}","title":"Delete transaction","href":"/api-reference/endpoints/transactions/delete-transaction"}]},{"group":"Users","pages":[{"openapi":"get /v1/users/{id}","title":"Get user","href":"/api-reference/endpoints/users/get-user"},{"openapi":"get /v1/users","title":"List users","href":"/api-reference/endpoints/users/list-users"}]},{"group":"Users > Roles","pages":[{"openapi":"get /v1/users/roles/{id}","title":"Get user role","href":"/api-reference/endpoints/users->-roles/get-user-role"},{"openapi":"get /v1/users/roles","title":"List user roles","href":"/api-reference/endpoints/users->-roles/list-user-roles"}]},{"group":"Wallets","pages":[{"openapi":"get /v1/wallets/settings","title":"Get wallet settings","href":"/api-reference/endpoints/wallets/get-wallet-settings"},{"openapi":"get /v1/wallets/{id}","title":"Get wallet","href":"/api-reference/endpoints/wallets/get-wallet"},{"openapi":"get /v2/wallets","title":"List wallets","href":"/api-reference/endpoints/wallets/list-wallets"},{"openapi":"get /v1/wallets/{id}/transactions","title":"List wallet transactions","href":"/api-reference/endpoints/wallets/list-wallet-transactions"},{"openapi":"post /v1/wallets","title":"Create wallet","href":"/api-reference/endpoints/wallets/create-wallet"},{"openapi":"patch /v1/wallets/settings","title":"Update wallet settings","href":"/api-reference/endpoints/wallets/update-wallet-settings"},{"openapi":"put /v1/wallets/{id}","title":"Update wallet","href":"/api-reference/endpoints/wallets/update-wallet"},{"openapi":"post /v1/wallets/{id}/load","title":"Load wallet","href":"/api-reference/endpoints/wallets/load-wallet"},{"openapi":"post /v1/wallets/{id}/transactions/{transactionId}/revert","title":"Revert wallet load","href":"/api-reference/endpoints/wallets/revert-wallet-load"}]},{"group":"Webhooks","pages":[{"openapi":"get /v1/webhooks/endpoints/{id}","title":"Get webhook endpoint","href":"/api-reference/endpoints/webhooks/get-webhook-endpoint"},{"openapi":"get /v1/webhooks/endpoints","title":"List webhook endpoints","href":"/api-reference/endpoints/webhooks/list-webhook-endpoints"},{"openapi":"get /v1/webhooks/messages","title":"List webhook messages","href":"/api-reference/endpoints/webhooks/list-webhook-messages"},{"openapi":"post /v1/webhooks/endpoints","title":"Create webhook endpoint","href":"/api-reference/endpoints/webhooks/create-webhook-endpoint"},{"openapi":"put /v1/webhooks/endpoints/{id}","title":"Update webhook endpoint","href":"/api-reference/endpoints/webhooks/update-webhook-endpoint"},{"openapi":"delete /v1/webhooks/endpoints/{id}","title":"Delete webhook endpoint","href":"/api-reference/endpoints/webhooks/delete-webhook-endpoint"}]}]},{"tab":"Guides","icon":"list-check","pages":[{"title":"Guides","href":"/guides/importing-historical-data"}]},{"tab":"Integrations","icon":"link","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Changelog","icon":"bullhorn","pages":[{"title":"Changelog","href":"/changelog/2026-10"}]}]},"basePath":"","title":"Get accounting rule tree - Hyperline","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","b0f84f53ff","2b790eda92","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-D9ithiIZ.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}